Struct SingleLineResponse 

pub struct SingleLineResponse {
    pub message: ControlMessage,
    pub code: String,
    pub message_text: String,
}

A simple single-line response from Tor.

SingleLineResponse represents responses that contain exactly one line, typically used for commands that perform actions rather than query data. These responses are usually “250 OK” on success or an error code with a description on failure.

Response Format

Single-line responses have the format:

STATUS CONTENT

For example:

• 250 OK - Success
• 552 Unrecognized key "foo" - Error

Example

use stem_rs::response::{ControlMessage, SingleLineResponse};

let msg = ControlMessage::from_str("250 OK\r\n", None, false).unwrap();
let response = SingleLineResponse::from_message(msg).unwrap();

assert!(response.is_ok(false));
assert!(response.is_ok(true)); // Strict check for "250 OK"
assert_eq!(response.code, "250");
assert_eq!(response.message_text, "OK");

Fields

message: ControlMessage

The underlying control message.

code: String

The 3-digit status code (e.g., “250”, “552”).

message_text: String

The message content after the status code.

Implementations

impl SingleLineResponse

pub fn from_message(message: ControlMessage) -> Result<Self, Error>

Creates a SingleLineResponse from a control message.

Validates that the message contains exactly one line and extracts the status code and message text.

Errors

Returns Error::Protocol if:

• The message contains more than one line
• The message is empty

Example

use stem_rs::response::{ControlMessage, SingleLineResponse};

// Valid single-line response
let msg = ControlMessage::from_str("250 OK\r\n", None, false).unwrap();
let response = SingleLineResponse::from_message(msg).unwrap();

// Multi-line response fails
let msg = ControlMessage::from_str("250-line1\r\n250 line2\r\n", None, false).unwrap();
assert!(SingleLineResponse::from_message(msg).is_err());

pub fn is_ok(&self, strict: bool) -> bool

Checks if the response indicates success.

Arguments

• strict - If true, requires exactly “250 OK”; if false, only checks for status code “250”

Returns

• Non-strict: true if status code is “250”
• Strict: true if response is exactly “250 OK”

Example

use stem_rs::response::{ControlMessage, SingleLineResponse};

let msg = ControlMessage::from_str("250 OK\r\n", None, false).unwrap();
let response = SingleLineResponse::from_message(msg).unwrap();
assert!(response.is_ok(false)); // Non-strict
assert!(response.is_ok(true));  // Strict

let msg = ControlMessage::from_str("250 Done\r\n", None, false).unwrap();
let response = SingleLineResponse::from_message(msg).unwrap();
assert!(response.is_ok(false));  // Non-strict passes
assert!(!response.is_ok(true));  // Strict fails (not "OK")

Trait Implementations

impl Clone for SingleLineResponse

fn clone(&self) -> SingleLineResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SingleLineResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.