Skip to main content

Content

Struct Content 

Source
#[non_exhaustive]
pub struct Content { pub text: String, pub lines: Vec<Line>, pub marks: Vec<Mark>, pub islands: Vec<Island>, }
Expand description

One content field as a content: the text plus the structure that rides on it.

Invariants (established once by import normalization, checked by Content::validate): the text holds no \r and no bidi controls; the count of ISLAND_SLOT equals islands.len(); lines.len() equals the number of \n-separated segments; marks are normalized (sorted, unioned).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§text: String

The content. \n is a line boundary; ISLAND_SLOT is an island slot.

§lines: Vec<Line>

One entry per \n-separated segment of text, in order. The line tree is derived from this flat list plus each line’s containers path: it is never stored, so a split/join is a single-char edit with no identity crisis (there are no paragraph IDs).

§marks: Vec<Mark>

Marks over char ranges, kept normalized: sorted by (start, end, kind-ord, attrs), same-kind formatting marks unioned.

§islands: Vec<Island>

One entry per ISLAND_SLOT, in slot order (ascending char position).

Implementations§

Source§

impl Content

Source

pub const RESERVED_MARK_TYPES: &'static [&'static str]

Mark type names the projection reserves; an MarkKind::Unknown may not reuse one (its serialization would parse back as the built-in, silently dropping its attrs: non-injective).

Two enforcement points, on two lanes. Content::validate catches an in-process Rust construction. The wire never reaches it: a decoder resolves the built-in name before the Unknown fallthrough, so a reserved tag becomes the built-in rather than arriving as an Unknown. The authored lane therefore rejects the shape up front (serial::from_authored_value for whole content; ops::mark_op_from_value and ops::line_op_from_value for the op wire), while storage decode stays lenient by design; see there.

This list and its two siblings are re-spelled by hand on the TypeScript surface: the unions in crates/bindings/wasm/src/engine.rs and the isUnknown* guards’ tables in crates/bindings/wasm/runtime/runtime.js. Both are pinned to these constants by crates/bindings/wasm/tests/known_names_drift.rs. Slices, not arrays, on all three: an array’s length is part of its type, and promoting a name into the projection is the motion these lists exist to absorb.

Source

pub const RESERVED_LINE_KINDS: &'static [&'static str]

Line kind names the projection reserves: the LineKind twin of RESERVED_MARK_TYPES, for the same injectivity reason.

Source

pub const RESERVED_CONTAINERS: &'static [&'static str]

Container names the projection reserves: the Container twin of RESERVED_MARK_TYPES.

Source

pub fn new(text: String, lines: Vec<Line>) -> Content

The text and its per-line attributes: what a content always carries. Marks and islands start empty and have with_marks / with_islands beside them.

Constructing does not normalize or check: the invariants in this type’s docs are the caller’s until validate runs. The codecs (crate::import, Content::from_canonical_json) establish them, and are what a consumer normally builds through.

Source

pub fn with_marks(self, marks: Vec<Mark>) -> Content

Set marks, the range-anchored marks over the text.

Source

pub fn with_islands(self, islands: Vec<Island>) -> Content

Set islands, one per ISLAND_SLOT in slot order.

Source

pub fn empty() -> Content

An empty content: one empty Para line, no marks, no islands.

Source

pub fn len_usv(&self) -> usize

Total length in USV.

Source

pub fn is_inline(&self) -> bool

Whether this content satisfies the richtext(inline) constraint: exactly one Para line, sitting in no container, with no islands. A single line can never continues (line 0 is always false), so that dimension is implied. Content::empty is inline (one empty Para), so a blank or zero-filled inline field passes.

Source

pub fn is_plain(&self) -> bool

Whether this content satisfies the plaintext constraint: no marks, no islands, and every line is a plain Para sitting in no container. It is the multi-line generalization of is_inline (which additionally pins the content to one line) with the mark/island exclusion made explicit: a plaintext value carries prose the author navigates but no formatting. continues is unconstrained: a lone \n may be a within-paragraph break. Content::empty is plain.

This is the plaintext analogue of is_inline, enforced at coercion and validation with the NotPlain error; the distinguishing property of plaintext over richtext { marks: [] } is the literal codec (crate::import::from_plaintext), not this predicate.

Source

pub fn is_blank(&self) -> bool

Whether the content carries no renderable content: the text is empty or whitespace-only. An island slot (ISLAND_SLOT, U+FFFC) is not whitespace, so an island-bearing content is never blank. Body-disabled validation and round-trip emit key on it.

Source

pub fn segment_count(&self) -> usize

Number of \n-separated segments: the required lines.len().

Source

pub fn normalize(&mut self)

Normalize marks in place: drop zero-width formatting, union same-kind formatting that is adjacent or overlapping, recursively key-sort island props and unknown-mark attrs, then sort marks canonically. Idempotent: the fixed point the canonical serialization commits to.

Source

pub fn validate(&self) -> Result<(), Invariant>

Check every invariant. Ok(()) on a well-formed content. Import guarantees this; a hand-built content should be run through it in tests.

Source§

impl Content

Source

pub fn apply_text_delta(&mut self, delta: &Delta) -> Result<(), ApplyError>

Splice text via delta, rebase marks, sync lines to \n changes, cascade island removal for any deleted slot, then normalize.

Islands stay in lockstep with their ISLAND_SLOT chars: a delta that deletes a slot drops the corresponding Island (the content goes away with its slot); a delta that inserts a raw slot is rejected (ApplyError::IslandSlotInInsert), islands are created through IslandOp::Insert, never a text splice, so a slot arriving here would orphan.

Inserted text is sanitized first: \r and Unicode bidi controls (the chars Content::validate forbids) are stripped, mirroring the normalization import applies at the string boundary. The text-delta channel is the other way text enters the content, so without this an insert of \r or a bidi control returned Ok while leaving a content that fails validate().

Source

pub fn apply_mark_ops(&mut self, ops: &[MarkOp]) -> Result<(), ApplyError>

Apply mark ops in final-text coordinates, then normalize.

Source

pub fn apply_island_ops(&mut self, ops: &[IslandOp]) -> Result<(), ApplyError>

Apply island ops: replace an entry by id, or insert a slot and its entry together.

Source

pub fn apply_line_ops(&mut self, ops: &[LineOp]) -> Result<(), ApplyError>

Apply line ops: split/join splice \n; set ops touch metadata only.

Source

pub fn apply_field_change( &mut self, bundle: &ChangeBundle, ) -> Result<(), ApplyError>

One committed field edit bundle: text delta, then island ops, then line ops, then marks, canonicalized by a single terminal normalize.

All-or-nothing: on any op’s error self is left exactly as it was, so a caller need not snapshot-and-restore around a failed bundle. A bundle carrying ops has several fallible stages that would otherwise partially commit, so it is staged on a scratch copy and swapped in only once every stage succeeds. The pure-text-delta path (the per-keystroke hot path) skips the clone: apply_text_delta validates the delta before mutating, so it is already atomic on the errors a caller can provoke.

Stage order is a coordinate contract, not a convenience: each stage reads the text the earlier ones left. Island ops sit between the delta and the line ops because both neighbors need them there. An island insert splices a slot, so a LineOp::SetKind { kind: Island } in the same bundle can only validate against a line that already carries it; Split/Join and every mark range are then measured in a frame that includes the new slots. The one-bundle block island (IslandOp::Insert) follows from that.

The stages run on their non-normalizing inner forms and normalize runs once at the end. One terminal normalize suffices because split/join rebase marks through their \n splice (map_pos semantics): the formatting-edge \n-trim then commutes with the line ops (trim-per-stage and trim-once converge), and MarkOp::Remove is coverage-set subtraction, which commutes with normalize’s same-kind union ((A ∪ B) \ R = (A\R) ∪ (B\R)). One canonicalization point, one pass.

Source§

impl Content

Source

pub fn to_canonical_json(&self) -> String

Serialize to canonical JSON bytes. Normalizes a copy first, so the output is canonical regardless of the caller’s mark/island order. Every object key is sorted recursively so the bytes do not depend on serde_json’s preserve_order feature being enabled in the consumer’s crate graph: the canonical form is feature-independent.

Source

pub fn from_canonical_json(s: &str) -> Result<Content, ParseError>

Parse canonical JSON, normalize (idempotent), and validate. Returns ParseError::Invalid for a content that violates its invariants, so storage cannot silently round-trip a malformed value. from_canonical_json(to_canonical_json(x)) round-trips to a canonical value and re-serializes to identical bytes.

Trait Implementations§

Source§

impl Clone for Content

Source§

fn clone(&self) -> Content

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 Content

Source§

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

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

impl PartialEq for Content

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
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> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
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> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.