Skip to main content

Znp

Struct Znp 

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

A ZNP client. Clones share one connection.

Implementations§

Source§

impl Znp

Source

pub async fn start<T>( io: T, config: ClientConfig, ) -> Result<(Znp, UnboundedReceiver<ZnpEvent>), ZnpError>
where T: AsyncRead + AsyncWrite + Send + 'static,

Connect over io: skip the bootloader, ping, and read the version, requiring Z-Stack 3. Indications arrive on the receiver; it is unbounded so a slow consumer never stalls responses.

Source

pub async fn open<T>( io: T, config: ClientConfig, ) -> Result<(Znp, UnboundedReceiver<ZnpEvent>), ZnpError>
where T: AsyncRead + AsyncWrite + Send + 'static,

Connect over io and read the version without requiring a supported product: what a probe needs.

Source

pub fn version(&self) -> Version

The firmware’s version.

Source

pub async fn request(&self, request: Request) -> Result<Vec<u8>, ZnpError>

Send a synchronous request and return its response data.

Source

pub async fn request_ok(&self, request: Request) -> Result<Vec<u8>, ZnpError>

A request whose response starts with a status byte; require success.

Source

pub async fn nv_read(&self, id: u16) -> Result<Option<Vec<u8>>, ZnpError>

Read a whole OSAL NV item. None when it does not exist.

Source

pub async fn nv_write(&self, id: u16, value: &[u8]) -> Result<(), ZnpError>

Write an OSAL NV item, creating it at this length if needed.

Source

pub async fn nv_ex_read( &self, sysid: u8, item: u16, sub: u16, ) -> Result<Option<Vec<u8>>, ZnpError>

Read a whole extended NV item. None when it does not exist.

Source

pub async fn nv_ex_write( &self, sysid: u8, item: u16, sub: u16, value: &[u8], ) -> Result<(), ZnpError>

Write an existing extended NV item.

Trait Implementations§

Source§

impl Clone for Znp

Source§

fn clone(&self) -> Self

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 Debug for Znp

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Znp

§

impl !UnwindSafe for Znp

§

impl Freeze for Znp

§

impl Send for Znp

§

impl Sync for Znp

§

impl Unpin for Znp

§

impl UnsafeUnpin for Znp

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.

§

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.

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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