Skip to main content

Message

Enum Message 

Source
pub enum Message {
Show 13 variants Open(Open), Close(Close), Synchronize(Synchronize), Request(Request), Cancel(Cancel), Data(Data), NoData(NoData), Want(Want), Unwant(Unwant), Bitfield(Bitfield), Range(Range), Extension(Extension), LocalSignal((String, Vec<u8>)),
}
Expand description

A protocol message.

Variants§

§

Open(Open)

§

Close(Close)

§

Synchronize(Synchronize)

§

Request(Request)

§

Cancel(Cancel)

§

Data(Data)

§

NoData(NoData)

§

Want(Want)

§

Unwant(Unwant)

§

Bitfield(Bitfield)

§

Range(Range)

§

Extension(Extension)

§

LocalSignal((String, Vec<u8>))

A local signalling message never sent over the wire

Implementations§

Source§

impl Message

Source

pub fn name(&self) -> &'static str

Get the name of the message

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

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 CompactEncoding for Message

Source§

fn encoded_size(&self) -> Result<usize, EncodingError>

The size in bytes required to encode self.
Source§

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

Encode self into buffer returning the remainder of buffer.
Source§

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>
where Self: Sized,

Decode a value from the given buffer of the type specified by the Decode type parameter (which defaults to Self). Returns the decoded value and remaining undecoded bytes.
Source§

fn to_encoded_bytes(&self) -> Result<Box<[u8]>, EncodingError>

Encode self into a Vec<u8>. This is just a helper method for creating a buffer and encoding to it in one step. Read more
Source§

fn create_buffer(&self) -> Result<Box<[u8]>, EncodingError>

Create an empty buffer of the correct size for encoding self to. This is just a helper method for: encoding to it in one step. Read more
Source§

fn encode_with_len<'a>( &self, buffer: &'a mut [u8], ) -> Result<(&'a mut [u8], usize), EncodingError>

Like CompactEncoding::encode but also return the number of bytes encoded.
Source§

fn decode_with_len( buffer: &[u8], ) -> Result<(Decode, &[u8], usize), EncodingError>

Like CompactEncoding::decode but also return the number of bytes decoded.
Source§

impl Debug for Message

Source§

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

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

impl Display for Message

Source§

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

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

impl From<Bitfield> for Message

Source§

fn from(value: Bitfield) -> Self

Converts to this type from the input type.
Source§

impl From<Cancel> for Message

Source§

fn from(value: Cancel) -> Self

Converts to this type from the input type.
Source§

impl From<Close> for Message

Source§

fn from(value: Close) -> Self

Converts to this type from the input type.
Source§

impl From<Data> for Message

Source§

fn from(value: Data) -> Self

Converts to this type from the input type.
Source§

impl From<Extension> for Message

Source§

fn from(value: Extension) -> Self

Converts to this type from the input type.
Source§

impl From<NoData> for Message

Source§

fn from(value: NoData) -> Self

Converts to this type from the input type.
Source§

impl From<Open> for Message

Source§

fn from(value: Open) -> Self

Converts to this type from the input type.
Source§

impl From<Range> for Message

Source§

fn from(value: Range) -> Self

Converts to this type from the input type.
Source§

impl From<Request> for Message

Source§

fn from(value: Request) -> Self

Converts to this type from the input type.
Source§

impl From<Synchronize> for Message

Source§

fn from(value: Synchronize) -> Self

Converts to this type from the input type.
Source§

impl From<Unwant> for Message

Source§

fn from(value: Unwant) -> Self

Converts to this type from the input type.
Source§

impl From<Want> for Message

Source§

fn from(value: Want) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Message

Source§

fn eq(&self, other: &Message) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Message

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> Instrument for T

Source§

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

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

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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