tor_cell::relaycell::msg

Struct Sendme

Source 
pub struct Sendme { /* private fields */ }
Expand description

A Sendme message is used to increase flow-control windows.

To avoid congestion, each Tor circuit and stream keeps track of a number of data cells that it is willing to send. It decrements these numbers every time it sends a cell. If these numbers reach zero, then no more cells can be sent on the stream or circuit.

The only way to re-increment these numbers is by receiving a Sendme cell from the other end of the circuit or stream.

For security, current circuit-level Sendme cells include an authentication tag that proves knowledge of the cells that they are acking.

See tor-spec.txt for more information; also see the source for tor_proto::circuit::sendme.

Implementations§

Source§

impl Sendme

Source

pub fn new_empty() -> Self

Return a new empty sendme cell

This format is used on streams, and on circuits without sendme authentication.

Source

pub fn new_tag(x: [u8; 20]) -> Self

This format is used on circuits with sendme authentication.

Source

pub fn into_sendme_tag(self) -> Option<SendmeTag>

Consume this cell and return its authentication tag, if any

Trait Implementations§

Source§

impl Body for Sendme

Source§

fn decode_from_reader(r: &mut Reader<'_>) -> Result<Self>

Decode a relay cell body from a provided reader.
Source§

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this cell into the end of a writer.
Source§

impl Clone for Sendme

Source§

fn clone(&self) -> Sendme

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 Sendme

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Sendme> for AnyRelayMsg

Source§

fn from(m: Sendme) -> AnyRelayMsg

Converts to this type from the input type.
Source§

impl From<SendmeTag> for Sendme

Source§

fn from(value: SendmeTag) -> Self

Converts to this type from the input type.
Source§

impl HasMemoryCostStructural for Sendme

Source§

fn indirect_memory_cost(&self, et: EnabledToken) -> usize

Memory cost of data stored out-of-line Read more
Source§

impl RelayMsg for Sendme

Source§

fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.
Source§

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this message, not including command or length
Source§

fn decode_from_reader(cmd: RelayCmd, r: &mut Reader<'_>) -> Result<Self>

Extract the body of a message with command cmd from reader r.
Source§

impl TryFrom<AnyRelayMsg> for Sendme

Source§

type Error = Error

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

fn try_from(msg: AnyRelayMsg) -> Result<Sendme>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for Sendme

§

impl RefUnwindSafe for Sendme

§

impl Send for Sendme

§

impl Sync for Sendme

§

impl Unpin for Sendme

§

impl UnwindSafe for Sendme

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> HasMemoryCost for T
where T: HasMemoryCostStructural,

Source§

fn memory_cost(&self, et: EnabledToken) -> usize

Returns the memory cost of self, in bytes Read more
Source§

impl<T> HasTypedMemoryCost<T> for T
where T: HasMemoryCost,

Source§

fn typed_memory_cost(&self, enabled: EnabledToken) -> TypedMemoryCost<T>

The cost, as a TypedMemoryCost<T> rather than a raw usize
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,