Struct reaper_medium::BookmarkId

pub struct BookmarkId(_);

A marker or region ID.

This uniquely identifies a marker or region. Zero is also a valid ID. Region IDs and marker IDs are two separate ID spaces.

Implementations

impl BookmarkId

pub fn new(number: u32) -> BookmarkId

Creates a marker ID.

pub const fn get(self) -> u32

Returns the wrapped value.

pub fn to_raw(self) -> i32

Converts this value to an integer as expected by the low-level API.

Trait Implementations

impl Clone for BookmarkId

fn clone(&self) -> BookmarkId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BookmarkId

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

Formats the value using the given formatter.

impl Default for BookmarkId

fn default() -> BookmarkId

Returns the “default value” for a type.

impl Display for BookmarkId

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

Formats the value using the given formatter.

impl Hash for BookmarkId

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,

Feeds a slice of this type into the given Hasher.

impl Ord for BookmarkId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BookmarkId> for BookmarkId

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<BookmarkId> for BookmarkId

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for BookmarkId

impl Eq for BookmarkId

impl StructuralEq for BookmarkId

impl StructuralPartialEq for BookmarkId