Struct SingleNameEventProducer

pub struct SingleNameEventProducer { /* private fields */ }

An event producer for an event containing only one name. It is slightly optimized, but otherwise functionally equivalent to the StaticVecEventProducer with an array of one element.

Implementations

impl SingleNameEventProducer

pub fn deleted() -> Self

Constructs a new SingleNameEventProducer that will produce an event for one name of type WatchEvent::Deleted. Deleted refers to the directory the watcher itself is on, and therefore statically refers to itself as “.”.

pub fn added(name: &str) -> Self

Constructs a new SingleNameEventProducer that will produce an event for one name of type WatchEvent::Added.

pub fn removed(name: &str) -> Self

Constructs a new SingleNameEventProducer that will produce an event for one name of type WatchEvent::Removed.

pub fn existing(name: &str) -> Self

Constructs a new SingleNameEventProducer that will produce an event for one name of type WatchEvent::Existing.

pub fn idle() -> Self

Constructs a new SingleNameEventProducer that will produce an WatchEvent::Idle event.

Trait Implementations

impl EventProducer for SingleNameEventProducer

fn mask(&self) -> WatchMask

Returns a mask that represents the type of events this producer can generate, as one of the fidl_fuchsia_io::WatchMask::* constants. There might be only one bit set and it should correspond to the event returned by the Self::event() method. It is a duplication, but it helps the callers that need both masks and event IDs.

fn event(&self) -> WatchEvent

Returns an event ID this event producer will use to populate the buffers, as one of the fidl_fuchsia_io::WatchEvent::* constants. Must match what Self::mask(), returns, see there for details.

fn prepare_for_next_buffer(&mut self) -> bool

Checks if this producer can create another buffer, returning true if it can. This method does not actually need to construct the buffer just yet, as an optimization if it will not be needed.

fn buffer(&mut self) -> Vec<u8>

Returns a copy of the current buffer prepared by this producer. This method will be the one constructing a buffer, if necessary, after a preceding call to Self::prepare_for_next_buffer().