Struct AtomicChannelId 

pub struct AtomicChannelId { /* private fields */ }

Available on crate feature api only.

A ChannelId which can be shared and updated atomically.

This behaves like an atomic variable holding a ChannelId, where the value can be read, set, replaced, or taken. Each operation takes an Ordering which is passed through to the underlying atomic.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::NONE;
assert_eq!(channel.load(Ordering::Acquire), ChannelId::NONE);

channel.store(ChannelId::from_u16(42), Ordering::Release);
assert_eq!(channel.load(Ordering::Acquire), ChannelId::from_u16(42));

assert_eq!(channel.take(Ordering::AcqRel), ChannelId::from_u16(42));
assert_eq!(channel.load(Ordering::Acquire), ChannelId::NONE);

Implementations

impl AtomicChannelId

pub const NONE: Self

An atomic channel id which contains ChannelId::NONE.

Since this is a constant every use of it constructs a new value, to share one it has to be bound to a static or a variable.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::NONE;
assert_eq!(channel.load(Ordering::Acquire), ChannelId::NONE);

pub const fn new(id: ChannelId) -> Self

Construct a new atomic channel id containing id.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::new(ChannelId::from_u16(1));
assert_eq!(channel.load(Ordering::Acquire), ChannelId::from_u16(1));

pub fn load(&self, ordering: Ordering) -> ChannelId

Read the current channel id.

ordering describes the memory ordering of this operation. Possible values are SeqCst, Acquire and Relaxed.

Panics

Panics if ordering is Release or AcqRel.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::new(ChannelId::from_u16(1));
assert_eq!(channel.load(Ordering::Acquire), ChannelId::from_u16(1));

pub fn store(&self, id: ChannelId, ordering: Ordering)

Set the current channel id to id, discarding the old value.

ordering describes the memory ordering of this operation. Possible values are SeqCst, Release and Relaxed.

Panics

Panics if ordering is Acquire or AcqRel.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::NONE;
channel.store(ChannelId::from_u16(1), Ordering::Release);
assert_eq!(channel.load(Ordering::Acquire), ChannelId::from_u16(1));

pub fn replace(&self, id: ChannelId, ordering: Ordering) -> ChannelId

Replace the current channel id with id, returning the old value.

ordering describes the memory ordering of this operation. All orderings are possible. Note that using Acquire makes the store part of this operation Relaxed, and using Release makes the load part Relaxed.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::new(ChannelId::from_u16(1));

let old = channel.replace(ChannelId::from_u16(2), Ordering::AcqRel);
assert_eq!(old, ChannelId::from_u16(1));
assert_eq!(channel.load(Ordering::Acquire), ChannelId::from_u16(2));

pub fn take(&self, ordering: Ordering) -> ChannelId

Take the current channel id, leaving ChannelId::NONE in its place.

ordering describes the memory ordering of this operation. All orderings are possible, see replace for details.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::new(ChannelId::from_u16(1));

assert_eq!(channel.take(Ordering::AcqRel), ChannelId::from_u16(1));
assert_eq!(channel.load(Ordering::Acquire), ChannelId::NONE);
assert_eq!(channel.take(Ordering::AcqRel), ChannelId::NONE);

pub fn into_inner(self) -> ChannelId

Consume the atomic channel id, returning the contained value.

Since this takes ownership no synchronization is needed.

Examples

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::new(ChannelId::from_u16(1));
assert_eq!(channel.into_inner(), ChannelId::from_u16(1));

Trait Implementations

impl Debug for AtomicChannelId

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

Formats the value using the given formatter.

impl Default for AtomicChannelId

fn default() -> Self

Construct an atomic channel id containing ChannelId::NONE.

Examples

use core::sync::atomic::Ordering;

use musli_web::api::{AtomicChannelId, ChannelId};

let channel = AtomicChannelId::default();
assert_eq!(channel.load(Ordering::Acquire), ChannelId::NONE);

impl From<ChannelId> for AtomicChannelId

fn from(id: ChannelId) -> Self

Converts to this type from the input type.