Struct Coordinate 

pub struct Coordinate {
    pub z: ZCoordinate,
    pub y: YCoordinate,
    pub x: XCoordinate,
}

---

@struct Coordinate

provides access to a default-initialized coordinate at 1.1.1/1.1.1/1.1.1

phext coordinates are formed along a 9-dimensional hierarchy with three main arms of the form z3.z2.z1/y3.y2.y1.x3.x2.x1 where:

Z - this arm contains the library (z3), shelf (z2), and series (z1) dimensions Y - this arm contains the collection (y3), volume (y2), and book (y1) dimensions X - this arm contains the chapter (x3), section (x2), and scroll (x1) dimensions

Fields

z: ZCoordinate

y: YCoordinate

x: XCoordinate

Implementations

impl Coordinate

pub fn new() -> Coordinate

impl Coordinate

pub fn validate_coordinate(&self) -> bool

---

@fn validate_coordinate

determines if coord points to a valid phext address

@param coord: the coordinate to reset

pub fn to_string(&self) -> String

---

@fn to_string

produces a quoted string for the given phext address in canonical format (z3.z2.z1/y3.y2.y1/x3.x2.x1)

@param coord the coordinate to translate

pub fn to_urlencoded(&self) -> String

pub fn scroll_break(&mut self)

---

@fn scroll_break

pub fn section_break(&mut self)

---

@fn section_break

pub fn chapter_break(&mut self)

---

@fn chapter_break

pub fn book_break(&mut self)

---

@fn book_break

pub fn volume_break(&mut self)

---

@fn volume_break

pub fn collection_break(&mut self)

---

@fn collection_break

pub fn series_break(&mut self)

---

@fn series_break

pub fn shelf_break(&mut self)

---

@fn shelf_break

pub fn library_break(&mut self)

---

@fn library_break

Trait Implementations

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Coordinate

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl Default for Coordinate

fn default() -> Coordinate

Returns the “default value” for a type.

impl Display for Coordinate

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

Formats the value using the given formatter.

impl Eq for Coordinate

impl Hash for Coordinate

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 Coordinate

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Coordinate

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Coordinate

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

impl TryFrom<&str> for Coordinate

---

@fn std::convert::TryFrom

type Error = PhextParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.