Struct Document

Source

pub struct Document {
    pub id: Uuid,
    pub title: String,
    pub blocks: Vec<Block>,
    pub metadata: HashMap<String, String>,
    pub created_at: u64,
    pub updated_at: u64,
}

Expand description

Represents a document containing multiple blocks

Fields§

§id: Uuid

Unique identifier for the document

§title: String

Title of the document

§blocks: Vec<Block>

List of blocks in the document

§metadata: HashMap<String, String>

Document metadata

§created_at: u64

Creation timestamp

§updated_at: u64

Last modification timestamp

Implementations§

Source §

impl Document

Source

pub fn new() -> Self

Creates a new empty document

§Example

use blocks::Document;

let doc = Document::new();
assert!(doc.blocks.is_empty());

Source

pub fn with_title(title: String) -> Self

Creates a new document with a title

§Arguments

title - The title of the document

§Example

use blocks::Document;

let doc = Document::with_title("My Document".to_string());
assert_eq!(doc.title, "My Document");

Source

pub fn add_block(&mut self, block: Block)

Adds a block to the document

§Arguments

block - The block to add

§Example

use blocks::{Document, Block, BlockType};

let mut doc = Document::new();
let block = Block::new(BlockType::Text, "Hello".to_string());
doc.add_block(block);
assert_eq!(doc.blocks.len(), 1);

Source

pub fn insert_block(&mut self, index: usize, block: Block) -> Result<()>

Inserts a block at a specific position

§Arguments

index - The position to insert at
block - The block to insert

§Returns

Result<(), BlocksError> - Ok if successful, Err if index is out of bounds

Source

pub fn remove_block(&mut self, id: Uuid) -> Result<Block>

Removes a block by its ID

§Arguments

id - The ID of the block to remove

§Returns

Result<Block, BlocksError> - The removed block if found

Source

pub fn remove_block_at(&mut self, index: usize) -> Result<Block>

Removes a block by index

§Arguments

index - The index of the block to remove

§Returns

Result<Block, BlocksError> - The removed block if found

Source

pub fn get_block(&self, id: Uuid) -> Option<&Block>

Gets a block by its ID

§Arguments

id - The ID of the block to find

§Returns

Option<&Block> - The block if found

Source

pub fn get_block_mut(&mut self, id: Uuid) -> Option<&mut Block>

Gets a mutable reference to a block by its ID

§Arguments

id - The ID of the block to find

§Returns

Option<&mut Block> - The mutable block if found

Source

pub fn get_block_at(&self, index: usize) -> Option<&Block>

Gets a block by index

§Arguments

index - The index of the block

§Returns

Option<&Block> - The block if found

Source

pub fn get_block_at_mut(&mut self, index: usize) -> Option<&mut Block>

Gets a mutable reference to a block by index

§Arguments

index - The index of the block

§Returns

Option<&mut Block> - The mutable block if found

Source

pub fn len(&self) -> usize

Returns the number of blocks in the document

Source

pub fn is_empty(&self) -> bool

Returns true if the document has no blocks

Source

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

Validates all blocks in the document

Source

pub fn to_format(&self, format: ConversionFormat) -> Result<String>

Converts the document to a specific format

§Arguments

format - The format to convert to

§Returns

Result<String, BlocksError> - The converted document

§Example

use blocks::{Document, Block, BlockType, ConversionFormat};

let mut doc = Document::new();
doc.add_block(Block::new(BlockType::Text, "Hello".to_string()));
let markdown = doc.to_format(ConversionFormat::Markdown).unwrap();
assert!(markdown.contains("Hello"));

Source