Struct EmojiExporter 

pub struct EmojiExporter;

Stateless serializer/deserializer for Emoji.

Implementations

impl EmojiExporter

pub fn to_binary(emoji: &Emoji) -> Result<Vec<u8>>

Serializes to the .cmse binary container (plaintext).

Examples found in repository

examples/build_emoji.rs (line 13)

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 to_binary_encrypted(emoji: &Emoji, keyring: &KeyRing) -> Result<Vec<u8>>

Serializes to .cmse, encrypting every block type named by the emoji’s Enc block with keyring.

pub fn from_binary(bytes: &[u8]) -> Result<Emoji>

Parses a .cmse container. Fails if any block is encrypted.

Examples found in repository

examples/build_emoji.rs (line 21)

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 from_binary_decrypted(bytes: &[u8], keyring: &KeyRing) -> Result<Emoji>

Parses a .cmse container, decrypting encrypted blocks with keyring (plaintext containers are accepted too).

pub fn to_unicode(emoji: &Emoji) -> Result<String>

Encodes to the Unicode envelope string (plane 15/16 PUA + tag chars). Always plaintext — encrypt bytes first if a confidential text-channel transport is needed.

Examples found in repository

examples/build_emoji.rs (line 14)

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 from_unicode(s: &str) -> Result<Emoji>

Decodes every block envelope found in s (other text is skipped).

Examples found in repository

examples/build_emoji.rs (line 23)

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");
}