Struct EmojiBuilder 

pub struct EmojiBuilder { /* private fields */ }

Fluent builder. build() is infallible: validation happens in the add_* methods, which repair inconsistent input (documented per method) instead of panicking.

Implementations

impl EmojiBuilder

pub fn new(name: &str) -> Self

Starts a builder; every emoji carries a text block so the name round-trips through the binary/unicode containers.

Examples found in repository

examples/build_emoji.rs (line 6)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

pub fn description(self, description: &str) -> Self

Sets the description on the text block.

Examples found in repository

examples/build_emoji.rs (line 7)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

pub fn add_todo(self, key: &str, value: &str) -> Self

Adds a todo item (status Pending), appending to an existing todo block when present.

Examples found in repository

examples/build_emoji.rs (line 8)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

pub fn add_image_rgba(self, width: u32, height: u32, rgba: Vec<u8>) -> Self

Adds a single-frame image block from raw RGBA8 pixels. If rgba does not match width * height * 4 it is zero-padded/truncated to fit (the builder never panics; strict validation lives in SpriteAtlas::validate).

Examples found in repository

examples/build_emoji.rs (line 9)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

pub fn with_agent_lifecycle(self) -> Self

Adds the default agent lifecycle: idle (initial), active, sleeping, with wake/sleep/activate/deactivate transitions.

Examples found in repository

examples/build_emoji.rs (line 10)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

pub fn encryption(self, encryption: EncryptionBlock) -> Self

Adds an encryption directive (which algorithm, which block types to encrypt at rest).

pub fn add_block(self, block: Block) -> Self

Appends any block.

pub fn build(self) -> Emoji

Finishes building. Infallible by design (see type docs).

Examples found in repository

examples/build_emoji.rs (line 11)

fn main() {
    let emoji = EmojiBuilder::new("my-emoji")
        .description("An emoji that does things")
        .add_todo("task1", "Build the thing")
        .add_image_rgba(64, 64, vec![0u8; 64 * 64 * 4])
        .with_agent_lifecycle()
        .build();

    let binary = EmojiExporter::to_binary(&emoji).expect("to_binary");
    let unicode = EmojiExporter::to_unicode(&emoji).expect("to_unicode");

    println!("emoji:      {}", emoji.name);
    println!("blocks:     {}", emoji.blocks.len());
    println!("binary:     {} bytes", binary.len());
    println!("unicode:    {} chars", unicode.chars().count());

    let back = EmojiExporter::from_binary(&binary).expect("from_binary");
    assert_eq!(emoji, back, "binary round-trip");
    let back = EmojiExporter::from_unicode(&unicode).expect("from_unicode");
    assert_eq!(emoji, back, "unicode round-trip");
    println!("round-trip: ok");
}

Trait Implementations

impl Clone for EmojiBuilder

fn clone(&self) -> EmojiBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmojiBuilder

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

Formats the value using the given formatter.