Struct polling::Events

source ·
pub struct Events { /* private fields */ }
Expand description

A container for I/O events.

Implementations§

source§

impl Events

source

pub fn new() -> Self

Create a new container for events, using the default capacity.

The default capacity is 1024.

§Examples
use polling::Events;

let events = Events::new();
source

pub fn with_capacity(capacity: NonZeroUsize) -> Self

Create a new container with the provided capacity.

§Examples
use polling::Events;
use std::num::NonZeroUsize;

let capacity = NonZeroUsize::new(1024).unwrap();
let events = Events::with_capacity(capacity);
source

pub fn iter(&self) -> impl Iterator<Item = Event> + '_

Create a new iterator over I/O events.

This returns all of the events in the container, excluding the notification event.

§Examples
use polling::{Event, Events, Poller};
use std::time::Duration;

let poller = Poller::new()?;
let mut events = Events::new();

poller.wait(&mut events, Some(Duration::from_secs(0)))?;
assert!(events.iter().next().is_none());
source

pub fn clear(&mut self)

Delete all of the events in the container.

§Examples
use polling::{Event, Events, Poller};

let poller = Poller::new()?;
let mut events = Events::new();

/* register some sources */

poller.wait(&mut events, None)?;

events.clear();
source

pub fn len(&self) -> usize

Returns the number of events in the container.

§Examples
use polling::Events;

let events = Events::new();
assert_eq!(events.len(), 0);
source

pub fn is_empty(&self) -> bool

Returns true if the container contains no events.

§Examples
use polling::Events;

let events = Events::new();
assert!(events.is_empty());
source

pub fn capacity(&self) -> NonZeroUsize

Get the total capacity of the list.

§Examples
use polling::Events;
use std::num::NonZeroUsize;

let cap = NonZeroUsize::new(10).unwrap();
let events = Events::with_capacity(std::num::NonZeroUsize::new(10).unwrap());
assert_eq!(events.capacity(), cap);

Trait Implementations§

source§

impl Debug for Events

source§

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

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

impl Default for Events

source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Events

§

impl !RefUnwindSafe for Events

§

impl Send for Events

§

impl !Sync for Events

§

impl Unpin for Events

§

impl UnwindSafe for Events

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

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
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>

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