Struct ValueChannel 

pub struct ValueChannel<V: Value + ?Sized> { /* private fields */ }

Channel used to read and write only value rather than other requests.

Implementations

impl<V: Value + ?Sized> ValueChannel<V>

pub fn put_ref(&mut self, data: &V) -> Result<Put<'_>, Error>

Write value by reference to the channel.

pub fn get_with<F>(&mut self, func: F) -> Get<'_, F>

where F: Callback<Request = V>,

Request value from the channel and call callback when it’s done.

pub fn subscribe_with<F: Queue<Request = V>>( &mut self, func: F, ) -> Subscription<'_, F>

Subscribe to value updates and call closure each time when update occured.

impl<T: Field> ValueChannel<[T]>

pub fn get_vec(&mut self) -> Get<'_, GetFn<[T], Vec<T>>>

Request array value and store it in Vec.

pub fn get_to_slice<'a, 'b>( &'a mut self, dst: &'b mut [T], ) -> Get<'a, GetToSlice<'b, T>>

Write value to slice and return received value length (which may be greater than dst length).

pub fn subscribe_vec(&mut self) -> Subscription<'_, LastFn<[T], Vec<T>>>

Subscribe to array value updates and obtain Vec stream.

impl<T: Field> ValueChannel<T>

pub fn put(&mut self, val: T) -> Result<Put<'_>, Error>

Write scalar value.

pub fn get(&mut self) -> Get<'_, GetFn<T, T>>

Get scalar value.

pub fn subscribe(&mut self) -> Subscription<'_, LastFn<T, T>>

Subscribe to updates of scalar value.

See TypedChannel::subscribe.

pub fn subscribe_buffered(&mut self) -> Subscription<'_, QueueFn<T, T>>

Subscribe to updates of scalar value and store all updates.

See TypedChannel::subscribe_buffered.

Methods from Deref<Target = TypedChannel<V>>

pub fn put_ref<R>(&mut self, req: &R) -> Result<Put<'_>, Error>

where R: TypedRequest<Value = V> + WriteRequest + ?Sized,

Make write request by reference.

pub fn get_with<R, F>(&mut self, func: F) -> Get<'_, F>

where R: TypedRequest<Value = V> + ReadRequest + ?Sized, F: Callback<Request = R>,

Make read request and call closure when it’s done, successfully or not.

pub fn subscribe_with<F: Queue>(&mut self, func: F) -> Subscription<'_, F>

where F::Request: TypedRequest<Value = V> + ReadRequest,

Subscribe to channel updates and call closure each time when update occured.

pub fn put<R>(&mut self, req: R) -> Result<Put<'_>, Error>

where R: TypedRequest<Value = T> + WriteRequest,

Write scalar request.

pub fn get<R>(&mut self) -> Get<'_, GetFn<R, R>>

where R: TypedRequest<Value = T> + ReadRequest + Copy,

Get result of scalar read request.

pub fn subscribe<R>(&mut self) -> Subscription<'_, LastFn<R, R>>

where R: TypedRequest<Value = T> + ReadRequest + Copy,

Subscribe to updates of scalar channel.

Note, that returned stream stores only last unread value. To store all values use Self::subscribe_buffered.

pub fn subscribe_buffered<R>(&mut self) -> Subscription<'_, QueueFn<R, R>>

where R: TypedRequest<Value = T> + ReadRequest + Copy,

Subscribe to updates of scalar channel and store all updates.

This subscription contains internal buffer that can grow up to arbitrary size especially in case of frequent channel updates.

Methods from Deref<Target = Channel>

pub fn connected(&mut self) -> Connect<'_>

Wait for channel become connected.

pub fn context(&self) -> &Context

Context of the channel.

pub fn raw(&self) -> chanId

Raw channed identifier.

pub fn name(&self) -> &CStr

Channel name.

pub fn field_type(&self) -> Result<FieldId, Error>

Channel field type.

pub fn element_count(&self) -> Result<usize, Error>

Number of elements in the channel.

pub fn host_name(&self) -> Result<&CStr, Error>

Name of the host which serves the channel.

pub fn put_ref<R: WriteRequest + ?Sized>( &mut self, req: &R, ) -> Result<Put<'_>, Error>

Make write request by reference.

pub fn get_with<F: Callback>(&mut self, func: F) -> Get<'_, F>

Make read request and call closure when it’s done, successfully or not.

pub fn subscribe_with<F: Queue>(&mut self, func: F) -> Subscription<'_, F>

Subscribe to channel updates and call closure each time when update occured.

Trait Implementations

impl<V: Value + ?Sized> Debug for ValueChannel<V>

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

Formats the value using the given formatter.

impl<V: Value + ?Sized> Deref for ValueChannel<V>

type Target = TypedChannel<V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V: Value + ?Sized> DerefMut for ValueChannel<V>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<V: Value + ?Sized> From<TypedChannel<V>> for ValueChannel<V>

fn from(original: TypedChannel<V>) -> ValueChannel<V>

Converts to this type from the input type.

impl<V: Value + ?Sized> From<ValueChannel<V>> for TypedChannel<V>

fn from(original: ValueChannel<V>) -> Self

Converts to this type from the input type.