Struct Binding

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

Protocol wrapper for a Zeek WebSocket connection.

See the module documentation for an introduction

Implementations§

Source§

impl Binding

Source

pub fn new<S>(subscriptions: S) -> Self
where S: Into<Subscriptions>,

Create a new Binding with the given Subscriptions.

let conn = Binding::new(&["topic"]);
Source

pub fn handle_incoming(&mut self, message: Message) -> Result<(), ProtocolError>

Handle received message.

Returns true if the data was converted to a Message and added to the inbox, or false otherwise.

§Errors
Source

pub fn outgoing(&mut self) -> Option<Bytes>

Get next data enqueued for sending.

Source

pub fn receive_event( &mut self, ) -> Result<Option<(String, Event)>, ProtocolError>

Get the next incoming event.

§Errors
Source

pub fn publish_event<S>( &mut self, topic: S, event: Event, ) -> Result<(), ProtocolError>
where S: Into<String>,

Enqueue an event for sending.

§Errors

Will return ProtocolError::SendOnNonSubscribed if the binding is not subscribed to the topic of the message.

Source

pub fn split(self) -> (Inbox, Outbox)

Split the Binding into an Inbox and Outbox.

The returned Inbox and Outbox do not enforce correct use of the protocol.

Auto Trait Implementations§

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

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V