Enum ockam::stream::StreamWorkerCmd

source · [−]

pub enum StreamWorkerCmd {
    Fetch,
    Pull {
        num: usize,
    },
}

Expand description

A protocol exchanged between a stream consumer and stream producer

Variants

`Fetch`

Trigger a fetch event

These events are fired from worker to itself to create a delayed reactive response

`Pull`

Fields

num: usize

Number of messages to pull.

Zero is used as a sentinal to indicate “all messages”.

Pull messages from the consumer’s buffer

Implementations

source

impl StreamWorkerCmd

source

pub fn fetch() -> ProtocolPayload

Return a ProtocolPayload containing a Fetch event.

source

pub fn pull(num: usize) -> ProtocolPayload

Pull messages from the consumer’s buffer

When sending Pull { num: 0 } all available messages are pulled. It is recommended to configure your stream consumer into “forwarding mode”.

Trait Implementations

source

impl Debug for StreamWorkerCmd

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for StreamWorkerCmd

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl ProtocolParser for StreamWorkerCmd

source

fn check_id(id: &str) -> bool

A function which checks whether this parser should be called for a particular protocol payload. Read more

source

fn parse(pp: ProtocolPayload) -> Result<Self>

Parse a ProtocolPayload, which must have a type supported by this parser. Read more

source

impl Serialize for StreamWorkerCmd

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Message for StreamWorkerCmd

Auto Trait Implementations

impl RefUnwindSafe for StreamWorkerCmd

impl Send for StreamWorkerCmd

impl Sync for StreamWorkerCmd

impl Unpin for StreamWorkerCmd

impl UnwindSafe for StreamWorkerCmd

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Decodable for T where
T: DeserializeOwned,

source

fn decode(encoded: &[u8 ]) -> Result<T, Error>

Decode a slice.

source

impl<T> Encodable for T where
T: Serialize,

source

fn encode(&self) -> Result<Vec<u8, Global>, Error>

Encode the type into an Encoded type.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Enum ockam::stream::StreamWorkerCmd

Variants

Fetch

Pull

Fields

Implementations

impl StreamWorkerCmd

pub fn fetch() -> ProtocolPayload

pub fn pull(num: usize) -> ProtocolPayload

Trait Implementations

impl Debug for StreamWorkerCmd

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

impl<'de> Deserialize<'de> for StreamWorkerCmd

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl ProtocolParser for StreamWorkerCmd

fn check_id(id: &str) -> bool

fn parse(pp: ProtocolPayload) -> Result<Self>

impl Serialize for StreamWorkerCmd

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

impl Message for StreamWorkerCmd

Auto Trait Implementations

impl RefUnwindSafe for StreamWorkerCmd

impl Send for StreamWorkerCmd

impl Sync for StreamWorkerCmd

impl Unpin for StreamWorkerCmd

impl UnwindSafe for StreamWorkerCmd

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Decodable for T where T: DeserializeOwned,

fn decode(encoded: &[u8]) -> Result<T, Error>

impl<T> Encodable for T where T: Serialize,

fn encode(&self) -> Result<Vec<u8, Global>, Error>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

`Fetch`

`Pull`

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Decodable for T where
T: DeserializeOwned,

fn decode(encoded: &[u8 ]) -> Result<T, Error>

impl<T> Encodable for T where
T: Serialize,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,