Struct onc_rpc::CallBody

pub struct CallBody<T, P>
where
    T: AsRef<[u8]>,
{ /* private fields */ }

A request invoking an RPC.

This structure is the Rust equivalent of the call_body structure defined in the RFC. The rpcvers field (representing the RPC protocol version) is hard coded to 2.

Implementations

impl<T, P> CallBody<T, P>

where T: AsRef<[u8]>, P: AsRef<[u8]>,

pub fn new( program: u32, program_version: u32, procedure: u32, auth_credentials: AuthFlavor<T>, auth_verifier: AuthFlavor<T>, payload: P ) -> Self

Construct a new RPC invocation request.

pub fn serialise_into<W: Write>(&self, buf: W) -> Result<(), Error>

Serialises this CallBody into buf, advancing the cursor position by CallBody::serialised_len() bytes.

pub fn serialised_len(&self) -> u32

Returns the on-wire length of this call body once serialised.

pub fn rpc_version(&self) -> u32

Returns the RPC version of this request.

This crate supports the ONC RPC version 2 only.

pub fn program(&self) -> u32

Returns the program identifier in this request.

pub fn program_version(&self) -> u32

The version of the program to be invoked.

pub fn procedure(&self) -> u32

The program procedure number identifying the RPC to invoke.

pub fn auth_credentials(&self) -> &AuthFlavor<T>

The credentials to use for authenticating the request.

pub fn auth_verifier(&self) -> &AuthFlavor<T>

The verifier that should be used to validate the authentication credentials.

The RFC says the following about the verifier:

The purpose of the authentication verifier is to validate the
authentication credential.  Note that these two items are
historically separate, but are always used together as one logical
entity.

pub fn payload(&self) -> &P

Returns a reference to the opaque message payload bytes.

Trait Implementations

impl<T, P: Debug> Debug for CallBody<T, P>

where T: AsRef<[u8]> + Debug,

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

Formats the value using the given formatter.

impl<T, P: PartialEq> PartialEq for CallBody<T, P>

where T: AsRef<[u8]> + PartialEq,

fn eq(&self, other: &CallBody<T, P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> TryFrom<&'a [u8]> for CallBody<&'a [u8], &'a [u8]>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for CallBody<Bytes, Bytes>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, P> StructuralPartialEq for CallBody<T, P>

where T: AsRef<[u8]>,