Struct FrameId 

pub struct FrameId(u64);

Tuple Fields

0: u64

Implementations

impl FrameId

pub const INVALID: FrameId

An invalid sentinel FrameId, which will always compare less than any valid FrameId.

pub fn first() -> Self

Returns a FrameId corresponding to the first frame.

Note that we use 0 as the internal id here because the current code increments the frame id at the beginning of the frame, rather than at the end, and we want the first frame to be 1. It would probably be sensible to move the advance() call to after frame-building, and then make this method return FrameId(1).

pub fn as_u64(&self) -> u64

Returns the backing u64 for this FrameId.

pub fn advance(&mut self)

Advances this FrameId to the next frame.

Trait Implementations

impl Add<u64> for FrameId

type Output = FrameId

The resulting type after applying the + operator.

fn add(self, other: u64) -> FrameId

Performs the + operation.

impl Clone for FrameId

fn clone(&self) -> FrameId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameId

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

Formats the value using the given formatter.

impl Default for FrameId

fn default() -> Self

Returns the “default value” for a type.

impl Hash for FrameId

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

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 MallocSizeOf for FrameId

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl Ord for FrameId

fn cmp(&self, other: &FrameId) -> 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 FrameId

fn eq(&self, other: &FrameId) -> 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 FrameId

fn partial_cmp(&self, other: &FrameId) -> 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 Peek for FrameId

unsafe fn peek_from(bytes: *const u8, output: *mut Self) -> *const u8

Deserialize from the buffer pointed to by bytes.

impl Poke for FrameId

fn max_size() -> usize

Return the maximum number of bytes that the serialized version of Self will occupy.

unsafe fn poke_into(&self, bytes: *mut u8) -> *mut u8

Serialize into the buffer pointed to by bytes.

impl Serialize for FrameId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<u64> for FrameId

type Output = FrameId

The resulting type after applying the - operator.

fn sub(self, other: u64) -> FrameId

Performs the - operation.

impl Copy for FrameId

impl Eq for FrameId

impl StructuralPartialEq for FrameId