Skip to main content

NoteDetails

Struct NoteDetails 

Source
pub struct NoteDetails {
    pub path: VaultPath,
    pub raw_text: String,
}
Expand description

A note’s vault path paired with its raw, unprocessed text.

This is the entry point for whole-note content extraction: title, hash, heading chunks, and links are all derived on demand from raw_text via the methods below — nothing is precomputed or cached here. The struct performs no I/O; the caller is responsible for loading the text.

Fields§

§path: VaultPath

Vault-internal path of the note, flattened on construction.

§raw_text: String

The note’s verbatim Markdown source, including any frontmatter.

Implementations§

Source§

impl NoteDetails

The one door to whole-note extraction. The borrowed-text associated functions (*_of) exist for bulk paths (indexing) that hold many notes’ text as &str and must not clone it; the get_* methods are the same operations over this note’s owned text.

Source

pub fn new<S: AsRef<str>>(note_path: &VaultPath, text: S) -> Self

Builds a NoteDetails from a vault path and the note’s raw text.

The path is flattened (./.. segments resolved) on the way in; the text is copied into the owned raw_text field unchanged.

Source

pub fn get_title_from_text<S: AsRef<str>>(text: S) -> String

Title of a note body, without constructing a NoteDetails.

Source

pub fn content_data_of<S: AsRef<str>>(text: S) -> NoteContentData

Indexable content data (title + hash) of a note body, without constructing a NoteDetails.

Source

pub fn content_chunks_of<S: AsRef<str>>(text: S) -> Vec<ContentChunk>

Heading-chunked content of a note body, without constructing a NoteDetails.

Heading chunks plus every link (note links, attachments, images, URLs, hashtags) of a note body at path, without constructing a NoteDetails.

Source

pub fn get_title(&self) -> String

Title of this note (first non-empty line of the body, frontmatter skipped).

Source

pub fn get_content_data(&self) -> NoteContentData

Indexable content data (title + content hash) of this note.

Source

pub fn get_content_chunks(&self) -> Vec<ContentChunk>

Heading-chunked content of this note, one ContentChunk per heading section.

Heading chunks plus every link (note links, attachments, images, URLs, hashtags) of this note, resolved against its own path.

Rendered Markdown of this note plus its extracted links: wikilinks become standard Markdown links, note links resolve to vault-relative absolute paths, hashtags become [#tag](#tag) links.

Trait Implementations§

Source§

impl Clone for NoteDetails

Source§

fn clone(&self) -> NoteDetails

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 NoteDetails

Source§

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

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

impl Display for NoteDetails

Source§

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

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

impl Eq for NoteDetails

Source§

impl PartialEq for NoteDetails

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NoteDetails

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more