natnet_decode

Struct NatNet

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

Parser for NatNet data

This is the main entry point to unpack/parse NatNet data.

Implementations§

Source§

impl NatNet

Source

pub fn new<V: Into<Version>>(ver: V) -> NatNet

Create a new NatNet parser with the given version

This will create a new parser that utilizes the given version for subsequent unpack calls

Source

pub fn unpack_with<B: BufRead>( ver: &Version, bytes: &mut B, ) -> Result<NatNetResponse>

Unpack a message from NatNet using a specified version

This will try to unpack a message coming from a NatNet application assuming the message uses the given version

Source

pub fn unpack_type_with<B: BufRead>( t: NatNetMsgType, ver: &Version, bytes: &mut B, ) -> Option<Result<NatNetResponse>>

Unpack only NatNetMsgType messages

This method unpacks only messages of the requested type. The function will consume the header of any NatNet message to check if it is the correct message and unpack only if it is. This method can be useful when needing to unpack only sender messages if NatNet version is unknown.

Source

pub fn unpack<B: BufRead>(&self, bytes: &mut B) -> Result<NatNetResponse>

Unpack a message from NatNet

Source

pub fn unpack_type<B: BufRead>( &self, t: NatNetMsgType, bytes: &mut B, ) -> Option<Result<NatNetResponse>>

Unpack only NatNetMsgType messages

This method unpacks only messages of the requested type. The function will consume the header of any NatNet message to check if it is the correct message and unpack only if it is. This method can be useful when needing to unpack only sender messages if NatNet version is unknown.

Trait Implementations§

Source§

impl Clone for NatNet

Source§

fn clone(&self) -> NatNet

Returns a copy 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 NatNet

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for NatNet

§

impl RefUnwindSafe for NatNet

§

impl Send for NatNet

§

impl Sync for NatNet

§

impl Unpin for NatNet

§

impl UnwindSafe for NatNet

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.