Enum Scope 

pub enum Scope {
    Root,
    Block(BlockId),
}

A scope holds shapes: either the document root, or a block. The root has no entity — it is never locked, never deleted, never renamed — so it is a variant, not a sentinel id (docs/type-level-invariants.md).

Variants

Root

Block(BlockId)

Implementations

impl Scope

pub fn from_wire(id: BlockId) -> Scope

The document boundary, inbound: registers and ops spell the root as BlockId::NULL, and this pair of conversions is the only place the editor reads or writes that sentinel.

pub fn wire_id(self) -> BlockId

The document boundary, outbound — see Self::from_wire.

pub fn block(self) -> Option<BlockId>

The block behind this scope, where there is one.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Hash for Scope

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 PartialEq for Scope

fn eq(&self, other: &Scope) -> 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 Copy for Scope

impl Eq for Scope

impl StructuralPartialEq for Scope