Struct conserve::bandid::BandId

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

Identifier for a band within an archive, eg ‘b0001’.

Implementations

impl BandId

pub fn new(seqs: &[u32]) -> BandId

Makes a new BandId from a sequence of integers.

pub fn zero() -> BandId

Return the origin BandId.

pub fn next_sibling(&self) -> BandId

Return the next BandId at the same level as self.

pub fn previous(&self) -> Option<BandId>

Return the previous band, unless this is zero.

This is only a calculation on the band id, and the band may not be present.

Currently only implemented for top-level bands.

Trait Implementations

impl Clone for BandId

fn clone(&self) -> BandId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BandId

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

Formats the value using the given formatter.

impl Display for BandId

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

Returns the string representation of this BandId.

Bands have an id which is a sequence of one or more non-negative integers. This is externally represented as a string like b0001-0010, which becomes their directory name in the archive.

Numbers are zero-padded to what should normally be a reasonable length, but they can be longer.

impl From<u32> for BandId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl FromStr for BandId

fn from_str(s: &str) -> Result<Self, Self::Err>

Make a new BandId from a string form.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for BandId

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 Ord for BandId

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

Restrict a value to a certain interval.

impl PartialEq for BandId

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

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

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 for BandId

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

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

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

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

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

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

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

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

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 Serialize for BandId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BandId

impl Eq for BandId

impl StructuralEq for BandId

impl StructuralPartialEq for BandId