Struct SignalId 

pub struct SignalId(/* private fields */);

Unique identifier for a signal within a document.

Signals are Level 1 in the hierarchy: raw entity detections. Each signal has a unique ID within its containing document.

Implementations

impl SignalId

pub const ZERO: SignalId

Zero ID constant.

pub const fn new(id: u64) -> SignalId

Create a new ID.

pub const fn get(self) -> u64

Get the raw u64 value.

pub const fn next(self) -> SignalId

Increment the ID and return the new value.

pub fn next_mut(&mut self) -> SignalId

Increment this ID in place and return the old value. Useful for generating sequential IDs.

Trait Implementations

impl Add<u64> for SignalId

type Output = SignalId

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> SignalId

Performs the + operation.

impl AddAssign<u64> for SignalId

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl Clone for SignalId

fn clone(&self) -> SignalId

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalId

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

Formats the value using the given formatter.

impl Default for SignalId

fn default() -> SignalId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignalId

fn deserialize<D>( deserializer: D, ) -> Result<SignalId, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SignalId

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

Formats the value using the given formatter.

impl From<i32> for SignalId

fn from(id: i32) -> SignalId

Converts to this type from the input type.

impl From<u64> for SignalId

fn from(id: u64) -> SignalId

Converts to this type from the input type.

impl From<usize> for SignalId

fn from(id: usize) -> SignalId

Converts to this type from the input type.

impl Hash for SignalId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SignalId

fn cmp(&self, other: &SignalId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SignalId

fn eq(&self, other: &SignalId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SignalId

fn partial_cmp(&self, other: &SignalId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SignalId

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SignalId

impl Eq for SignalId

impl StructuralPartialEq for SignalId