Skip to main content

ActiveDocument

Struct ActiveDocument 

Source
pub struct ActiveDocument(/* private fields */);
Expand description

M.0 (2026-05-31): the active-document slot held by Editor.document. Wraps an Arc<dyn Document> so that:

  • The slot can hold either a regular rope-backed handle (today: RopeDocumentHandle, renamed to RopeDocumentHandle in M.0 Phase E) or a MultibufferDocumentHandle (M.1) without kind-branching at the use site — dispatch / motion / render code paths just call Document trait methods through Deref<Target = dyn Document>.

  • The slot impls Default (initialised to a placeholder rope handle via RopeDocumentHandle::default()) so consumers that #[derive(Default)] over a struct containing this field work without hand-rolling the impl. The placeholder’s actor receiver is closed immediately at construction, so any traffic sent through the placeholder reports RuntimeError::ActorGone — production code overwrites the slot before any real traffic flows.

  • The newtype is cheap to clone (one atomic refcount bump on the inner Arc).

Arc<dyn Document> directly cannot implement Default (orphan rule on Arc + dyn Trait: !Sized), so this newtype is the smallest viable wrapper that keeps the derive ergonomics intact without forcing a manual impl Default over every struct that holds the slot.

Implementations§

Source§

impl ActiveDocument

Source

pub fn new<D: Document>(handle: D) -> Self

Wrap a concrete document handle. The handle must impl Document (today: RopeDocumentHandle / future RopeDocumentHandle; M.1: MultibufferDocumentHandle).

Source

pub fn from_arc(arc: Arc<dyn Document>) -> Self

Wrap an already-Arc’d handle. Useful when an Arc<dyn Document> is constructed elsewhere (e.g., by the buffer registry) and the slot just takes ownership of it.

Source

pub fn as_arc(&self) -> Arc<dyn Document> ⓘ

Cheap clone of the inner Arc. Use when handing the reference off to a long-lived consumer that wants to store it independently.

Trait Implementations§

Source§

impl Clone for ActiveDocument

Source§

fn clone(&self) -> ActiveDocument

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 ActiveDocument

Source§

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

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

impl Default for ActiveDocument

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Deref for ActiveDocument

Source§

type Target = dyn Document

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

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.

§

impl<T> Instrument for T

§

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

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

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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, 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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