Skip to main content

ConceptId

Struct ConceptId 

Source
pub struct ConceptId { /* private fields */ }
Expand description

A concept identifier: an ordered list of path segments (e.g. ["tables", "users"] for tables/users).

Implementations§

Source§

impl ConceptId

Source

pub fn new(segments: Vec<String>) -> Result<Self, ConceptIdError>

Builds a concept id from segments, validating each.

§Errors

Returns ConceptIdError if segments is empty or any segment fails validate_segment.

Source

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

Parses a concept id from a /-separated string. Empty segments are dropped (so leading/trailing/duplicate slashes are tolerated), matching the reference parse_concept_id.

§Errors

Returns ConceptIdError if s resolves to no segments or any segment fails validate_segment.

Source

pub fn segments(&self) -> &[String]

The id’s segments.

Source

pub fn name(&self) -> &str

The final segment (the concept’s own name, without directories).

Source

pub fn parent(&self) -> Option<Self>

The id of the directory that contains this concept, if any.

Source

pub fn to_path(&self, bundle_root: &Path) -> PathBuf

Resolves this id to a file path under bundle_root (appending .md).

§Panics

Never panics in practice: the constructor rejects empty segment lists, so ConceptId::segments always has at least one element.

Source

pub fn from_path( bundle_root: &Path, path: &Path, ) -> Result<Self, ConceptIdError>

Derives a concept id from a file path relative to bundle_root, stripping the .md suffix.

The path must be a normalized, UTF-8 .md path whose segments can be represented by a ConceptId. A file already on disk is a concept whatever its portable spelling, and conformance is a question of frontmatter, not filenames, so names such as my notes.md remain valid. Rejecting non-UTF-8 names rather than replacing them is important: a replacement character would produce an id that does not point back to the original file.

§Errors

Returns ConceptIdError if path is not under bundle_root or resolves to no segments, is not a .md file, contains a non-normal path component, or cannot be represented as UTF-8 without loss.

Trait Implementations§

Source§

impl Clone for ConceptId

Source§

fn clone(&self) -> ConceptId

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConceptId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ConceptId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ConceptId

Source§

impl FromStr for ConceptId

Source§

type Err = ConceptIdError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ConceptId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ConceptId

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ConceptId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ConceptId

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ConceptId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.