Struct scpi::Context

source ·
pub struct Context<'a> {
    pub mav: bool,
    pub user: &'a dyn Any,
}
Expand description

Context in which to execute a message.

Useful when multiple sources can execute commands.

Fields§

§mav: bool

Does output buffer contain data?

§user: &'a dyn Any

User context data.

Do not use this to pass application data! Use traits instead. It’s only intended to pass along data from whatever context is running a command.

For example: User authentication information if the call comes from an authenticated interface or port number if the call comes from a serial port.

Implementations§

source§

impl<'a> Context<'a>

source

pub fn new() -> Self

Create a new context

source

pub fn new_with_user(user: &'a dyn Any) -> Self

source

pub fn user<U: Any>(&'a self) -> Option<&'a U>

Get user context data.

DO NOT USE FOR APPLICATION DATA

source

pub fn mav(&self) -> bool

Returns true if output buffer contains data

Trait Implementations§

source§

impl<'a> Debug for Context<'a>

source§

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

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

impl<'a> Default for Context<'a>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Context<'a>

§

impl<'a> !RefUnwindSafe for Context<'a>

§

impl<'a> !Send for Context<'a>

§

impl<'a> !Sync for Context<'a>

§

impl<'a> Unpin for Context<'a>

§

impl<'a> !UnwindSafe for Context<'a>

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> 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> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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.