Struct onc_rpc::RpcMessage

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

An Open Network Computing RPC message, generic over a source of bytes (T) and a payload buffer (P`).

Implementations

impl<'a> RpcMessage<&'a [u8], &'a [u8]>

pub fn from_bytes(
    buf: &'a [u8]
) -> Result<RpcMessage<&'a [u8], &'a [u8]>, Error>

Deserialises a new RpcMessage from buf.

Buf must contain exactly 1 message - if buf contains an incomplete message, or buf contains trailing bytes after the message IncompleteMessage is returned.

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

pub fn new(xid: u32, message_type: MessageType<T, P>) -> Self

Construct a new RpcMessage with the specified transaction ID and message body.

pub fn serialise_into(&self, buf: &mut Cursor<Vec<u8>>) -> Result<(), Error>

Write this RpcMessage into buf, advancing the cursor to the end of the serialised message. buf must have capacity for at least serialised_len bytes from the current cursor position.

This method allows the caller to specify the underlying buffer used to hold the serialised message to enable reuse and pooling.

pub fn serialise(&self) -> Result<Vec<u8>, Error>

Serialise this RpcMessage into a new Vec.

The returned vec will be sized exactly to contain this message. Calling this method is the equivalent of:

let mut buf = Vec::with_capacity(msg.serialised_len() as usize);
let mut c = Cursor::new(buf);
msg.serialise_into(&mut c);

pub fn serialised_len(&self) -> u32

Returns the on-wire length of this message once serialised, including the message header.

pub fn xid(&self) -> u32

The transaction ID for this request.

pub fn message(&self) -> &MessageType<T, P>

The MessageType contained in this request.

pub fn call_body(&self) -> Option<&CallBody<T, P>>

Returns the CallBody in this request, or None if this message is not a RPC call request.

pub fn reply_body(&self) -> Option<&ReplyBody<T, P>>

Returns the ReplyBody in this request, or None if this message is not a RPC response.

Trait Implementations

impl<T: Debug, P: Debug> Debug for RpcMessage<T, P> where
    T: AsRef<[u8]>,
    P: AsRef<[u8]>, 

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

Formats the value using the given formatter.

impl<T: PartialEq, P: PartialEq> PartialEq<RpcMessage<T, P>> for RpcMessage<T, P> where
    T: AsRef<[u8]>,
    P: AsRef<[u8]>, 

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

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

pub fn ne(&self, other: &RpcMessage<T, P>) -> bool

This method tests for !=.

impl<T, P> StructuralPartialEq for RpcMessage<T, P> where
    T: AsRef<[u8]>,
    P: AsRef<[u8]>, 

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Bytes> for RpcMessage<Bytes, Bytes>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.