GetConfResponse

Struct GetConfResponse 

Source
pub struct GetConfResponse {
    pub entries: HashMap<String, Vec<String>>,
}
Expand description

Parsed response from the GETCONF command.

Contains a mapping of configuration option names to their values. Options can have zero, one, or multiple values.

§Value Semantics

  • Empty Vec: Option is unset or using default value
  • Single element: Option has one value
  • Multiple elements: Option has multiple values (e.g., ExitPolicy)

§Example

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

let msg = ControlMessage::from_str(
    "250-ControlPort=9051\r\n\
     250-DirPort\r\n\
     250 OK\r\n",
    None,
    false
).unwrap();

let response = GetConfResponse::from_message(&msg).unwrap();

// ControlPort has a value
assert_eq!(
    response.entries.get("ControlPort"),
    Some(&vec!["9051".to_string()])
);

// DirPort is unset (empty Vec)
assert_eq!(response.entries.get("DirPort"), Some(&vec![]));

Fields§

§entries: HashMap<String, Vec<String>>

Mapping of configuration option names to their values.

Each key is a configuration option name (e.g., “ControlPort”). Each value is a Vec of strings:

  • Empty Vec: option is unset
  • Single element: option has one value
  • Multiple elements: option has multiple values

Implementations§

Source§

impl GetConfResponse

Source

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

Parses a GETCONF response from a control message.

Extracts configuration option names and their values from the response.

§Arguments
  • message - The control message to parse
§Errors

Returns an error if:

§Example
use stem_rs::response::{ControlMessage, GetConfResponse};

// Successful response
let msg = ControlMessage::from_str(
    "250-SocksPort=9050\r\n250 OK\r\n",
    None,
    false
).unwrap();
let response = GetConfResponse::from_message(&msg).unwrap();
assert_eq!(
    response.entries.get("SocksPort"),
    Some(&vec!["9050".to_string()])
);

// Empty response (no options requested)
let msg = ControlMessage::from_str("250 OK\r\n", None, false).unwrap();
let response = GetConfResponse::from_message(&msg).unwrap();
assert!(response.entries.is_empty());

Trait Implementations§

Source§

impl Clone for GetConfResponse

Source§

fn clone(&self) -> GetConfResponse

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GetConfResponse

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.