Skip to main content

XidParams

Struct XidParams 

Source
pub struct XidParams {
    pub max_info_tx: u16,
    pub max_info_rx: u16,
    pub window_tx: u8,
    pub window_rx: u8,
}
Expand description

XID parameters negotiated during the SNRM/UA exchange (IEC 62056-46 §6.4.4.4.3.2): the maximum information field length and window size each station uses in each direction.

Encoded on the wire as the SNRM/UA information field: 81 80 <group-len> 05 02 <max_info_tx:u16> 06 02 <max_info_rx:u16> 07 04 <window_tx:u32> 08 04 <window_rx:u32> (big-endian values; the window fields are 4 octets on the wire though only small values, 1..7, are meaningful).

Fields§

§max_info_tx: u16

Maximum information field length this station will transmit.

§max_info_rx: u16

Maximum information field length this station will receive.

§window_tx: u8

Window size (1..7) this station uses when transmitting.

§window_rx: u8

Window size (1..7) this station uses when receiving.

Implementations§

Source§

impl XidParams

Source

pub fn client_default() -> Self

The client’s default ceiling: 1280-octet info fields, window 1.

Source

pub fn server_default() -> Self

The server’s default ceiling: 512-octet info fields, window 1.

Source

fn encode(self) -> Vec<u8> ⓘ

Source

fn decode(data: &[u8]) -> XidParams

Decodes XID parameters from an SNRM/UA information field. Fields not present (or a field whose value is 0, meaning “no opinion”) are left at 0 so Self::negotiate treats them as absent.

Source

fn negotiate(&mut self, peer: XidParams)

Tightens self (this station’s ceiling) against peer’s proposal: a direction is only ever narrowed, and a zero value from the peer (no opinion / absent) leaves that field unchanged.

Trait Implementations§

Source§

impl Clone for XidParams

Source§

fn clone(&self) -> XidParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for XidParams

Source§

impl Debug for XidParams

Source§

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

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

impl Eq for XidParams

Source§

impl PartialEq for XidParams

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for XidParams

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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