Struct ublox_cellular::sockets::SocketSet

pub struct SocketSet<N, L> where
    N: ArrayLength<Option<Item<L>>>,
    L: ArrayLength<u8>,  {
    pub sockets: Vec<Option<Item<L>>, N>,
}

An extensible set of sockets.

Fields

sockets: Vec<Option<Item<L>>, N>

Implementations

impl<N, L> Set<N, L> where
    N: ArrayLength<Option<Item<L>>>,
    L: ArrayLength<u8>, 

pub fn new() -> Set<N, L>

Create a socket set using the provided storage.

pub fn capacity(&self) -> usize

Get the maximum number of sockets the set can hold

pub fn len(&self) -> usize

Get the current number of initialized sockets, the set is holding

pub fn is_empty(&self) -> bool

Check if the set is currently holding no active sockets

pub fn socket_type(&self, handle: Handle) -> Option<SocketType>

Get the type of a specific socket in the set.

Returned as a SocketType

pub fn add<T>(&mut self, socket: T) -> Result<Handle, Error> where
    T: Into<Socket<L>>, 

Add a socket to the set with the reference count 1, and return its handle.

pub fn get<T: AnySocket<L>>(
    &mut self,
    handle: Handle
) -> Result<SocketRef<'_, T>, Error>

Get a socket from the set by its handle, as mutable.

pub fn remove(&mut self, handle: Handle) -> Result<Socket<L>, Error>

Remove a socket from the set, without changing its state.

pub fn retain(&mut self, handle: Handle) -> Result<(), Error>

Increase reference count by 1.

pub fn release(&mut self, handle: Handle) -> Result<(), Error>

Decrease reference count by 1.

pub fn prune(&mut self)

Prune the sockets in this set.

Pruning affects sockets with reference count 0. Open sockets are closed. Closed sockets are removed and dropped.

pub fn iter(&self) -> impl Iterator<Item = (Handle, &Socket<L>)>

Iterate every socket in this set.

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = (Handle, SocketRef<'_, Socket<L>>)>

Iterate every socket in this set, as SocketRef.

Trait Implementations

impl<N: Default, L: Default> Default for Set<N, L> where
    N: ArrayLength<Option<Item<L>>>,
    L: ArrayLength<u8>, 

pub fn default() -> Set<N, L>

Returns the "default value" for a type.