Struct BlockPath 

pub struct BlockPath(Vec<BlockId>);

The blocks descended into, outermost first. The scope being edited is the last segment; an empty path is the document root, which is a scope like any other.

Tuple Fields

0: Vec<BlockId>

Implementations

impl BlockPath

pub fn empty() -> Self

pub fn opening(doc: &Document) -> Self

The path that opens doc: inside its designated top block, or the document root while there is no top yet.

pub fn to_parent_of(doc: &Document, target: BlockId) -> Option<Self>

The path whose scope holds target, or None for a block the document does not hold. A top-level block’s path is the empty one.

pub fn showing(doc: &Document, scope: Scope) -> Option<Self>

The path whose scope is scope: the trail down to it with the scope’s own block last. None for a block the document does not hold; the root is always reachable.

pub fn scope(&self) -> Scope

The scope being edited. Segments are real blocks only — descending is Self::pushing a block — so the empty path is the root, not a path to a sentinel.

pub fn push(&mut self, id: BlockId)

pub fn pop(&mut self) -> Option<BlockId>

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

pub fn is_held_by(&self, doc: &Document) -> bool

Whether every segment is a block doc still holds. The root path always is — it is a scope, not a block. Asked when the document under the editor changes to one that may never have held the blocks this path descends through (the time machine).

Trait Implementations

impl Clone for BlockPath

fn clone(&self) -> BlockPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockPath

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

Formats the value using the given formatter.

impl Default for BlockPath

fn default() -> BlockPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockPath

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

Formats the value using the given formatter.

impl PartialEq for BlockPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BlockPath

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BlockPath

impl StructuralPartialEq for BlockPath