Struct HunkId 

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

A canonical hunk, in memory.

The wire form is h<N>, where N indexes doc.hunks — frozen since schema v1 and unchanged by this type. HunkId is only ever the parsed form: it never crosses a serde boundary, so the contract stays exactly as spec/json-contract.md describes it while callers stop re-parsing strings.

Implementations

impl HunkId

pub const fn from_index(index: usize) -> Self

pub const fn index(self) -> usize

pub fn parse(s: &str) -> Result<Self, EngineError>

Parse the wire form.

Fallible on purpose. A malformed id means the document contradicts its own contract, which is impossible for a document this process just produced and possible for one read back from a review store — so the caller gets an error to propagate instead of a panic.

Trait Implementations

impl Clone for HunkId

fn clone(&self) -> HunkId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HunkId

impl Debug for HunkId

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

Formats the value using the given formatter.

impl Display for HunkId

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

Writes the wire form, so format!("{id}") round-trips through parse.

impl Eq for HunkId

impl Hash for HunkId

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 HunkId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HunkId

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