Skip to main content

Block

Struct Block 

Source
pub struct Block {
    pub id: BlockId,
    pub content: Content,
    pub metadata: BlockMetadata,
    pub edges: Vec<Edge>,
    pub version: Version,
}
Expand description

A block is the fundamental unit of content in UCM.

Blocks are immutable, content-addressed units identified by deterministic IDs derived from their content. They contain typed content, metadata for search and display, and edges representing relationships to other blocks.

§Example

use ucm_core::{Block, Content};

let block = Block::new(Content::text("Hello, UCM!"), Some("intro"));
println!("Block ID: {}", block.id);

Fields§

§id: BlockId

Unique, content-derived identifier

§content: Content

The actual content

§metadata: BlockMetadata

Block metadata

§edges: Vec<Edge>

Explicit relationships to other blocks

§version: Version

Version for optimistic concurrency control

Implementations§

Source§

impl Block

Source

pub fn new(content: Content, semantic_role: Option<&str>) -> Self

Create a new block with generated ID

Source

pub fn with_id(id: BlockId, content: Content) -> Self

Create a new block with a specific ID (for deserialization or testing)

Source

pub fn root() -> Self

Create a root block

Source

pub fn with_metadata(self, metadata: BlockMetadata) -> Self

Set metadata

Source

pub fn with_label(self, label: impl Into<String>) -> Self

Set label

Source

pub fn with_tag(self, tag: impl Into<String>) -> Self

Add a tag

Source

pub fn with_edge(self, edge: Edge) -> Self

Add an edge

Source

pub fn with_edges(self, edges: impl IntoIterator<Item = Edge>) -> Self

Add multiple edges

Source

pub fn content_type(&self) -> &'static str

Get the content type tag

Source

pub fn is_root(&self) -> bool

Check if the block is a root block

Source

pub fn token_estimate(&self) -> TokenEstimate

Get the estimated token count

Source

pub fn size_bytes(&self) -> usize

Get content size in bytes

Source

pub fn update_content(&mut self, content: Content, semantic_role: Option<&str>)

Update the content and regenerate ID

Source

pub fn add_edge(&mut self, edge: Edge)

Add an edge to this block

Source

pub fn remove_edge(&mut self, target: &BlockId, edge_type: &EdgeType) -> bool

Remove an edge by target and type

Source

pub fn edges_of_type(&self, edge_type: &EdgeType) -> Vec<&Edge>

Get edges of a specific type

Source

pub fn has_tag(&self, tag: &str) -> bool

Check if block has a specific tag

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Block

Source§

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

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

impl<'de> Deserialize<'de> for Block

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Block

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Block

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Block

Auto Trait Implementations§

§

impl Freeze for Block

§

impl RefUnwindSafe for Block

§

impl Send for Block

§

impl Sync for Block

§

impl Unpin for Block

§

impl UnwindSafe for Block

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.

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> 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, 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,