Struct Message

pub struct Message { /* private fields */ }

Container of binary data, which also includes a header. This header is a special collection of data which isn’t used in things like encoding, as it is meant to be a lightweight message with information about the contained data.

Implementations

impl Message

pub fn new() -> Message

Create an empty message.

Examples found in repository

examples/message/main.rs (line 4)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

examples/sound_channel/main.rs (line 18)

fn main() {
    let modulation = MFSK::new(16);
    let channel = Sound::new(&modulation);

    // let time = 20;

    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);

    let msg = Message::new().data("Hello world!");
    channel.send(&msg, 100);
}

examples/wav_export/main.rs (line 4)

fn main() {
    let msg = Message::new().data(
        "Peter Piper picked a peck of pickled peppers
A peck of pickled peppers Peter Piper picked
If Peter Piper picked a peck of pickled peppers
Where's the peck of pickled peppers Peter Piper picked?",
    );

    let time = 100;

    let fsk256 = MFSK::new(256).base_frequency(100).delta_frequency(30);
    let channel256 = Sound::new(&fsk256);
    channel256.export_wav(&msg, "examples/wav_export/audio/256fsk.wav", time);

    let fsk16 = MFSK::new(16).base_frequency(100).delta_frequency(100);
    let channel16 = Sound::new(&fsk16);
    channel16.export_wav(&msg, "examples/wav_export/audio/16fsk.wav", time);

    let qam256 = MQAM::new(256, 1000);
    let channel256 = Sound::new(&qam256);
    channel256.export_wav(&msg, "examples/wav_export/audio/256qam.wav", time);

    let qam16 = MQAM::new(16, 1000);
    let channel16 = Sound::new(&qam16);
    channel16.export_wav(&msg, "examples/wav_export/audio/16qam.wav", time);
}

pub fn from_string(data: &str, header: &str) -> Message

Create a message from some given data and a header as strings. These are transformed into binary and then stored.

Examples found in repository

examples/huffman_coding/main.rs (line 4)

fn main() {
    let small_msg = Message::from_string("Hello world!", "HEADER");
    let encoder = HuffmanCoding::from_message(&small_msg);
    let small_enc = encoder.encode(&small_msg);
    let small_dec = encoder.decode(&small_enc, 0);
    println!("{}", encoder);
    println!("{} -> DECODED : {}", small_msg, small_dec);
    println!(
        "\n=== SIZES ===\n{} b -> ENCODED : {} b -> DECODED : {} b",
        small_msg.bit_size(),
        small_enc.bit_size(),
        small_dec.bit_size()
    );

    println!("\n\n");

    let msg1 = Message::from_string(
        "Peter Piper picked a peck of pickled peppers
    A peck of pickled peppers Peter Piper picked
    If Peter Piper picked a peck of pickled peppers
    Where's the peck of pickled peppers Peter Piper picked?",
        "THIS IS A TEST HEADER",
    );
    let encoder1 = HuffmanCoding::from_message(&msg1);
    let msg1_enc = encoder1.encode(&msg1);
    let msg1_dec = encoder1.decode(&msg1_enc, 0);
    println!("{}", encoder);
    println!("{} -> DECODED : {}", msg1, msg1_dec);
    println!(
        "\n=== SIZES ===\n{} b -> ENCODED : {} b -> DECODED : {} b",
        msg1.bit_size(),
        msg1_enc.bit_size(),
        msg1_dec.bit_size()
    );
}

pub fn from_binary(data: &str, header: &str) -> Message

Create a message from some given data and header binaries.

pub fn data(self, data: &str) -> Message

Set the data of the message.

Examples found in repository

examples/message/main.rs (line 4)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

examples/sound_channel/main.rs (line 18)

fn main() {
    let modulation = MFSK::new(16);
    let channel = Sound::new(&modulation);

    // let time = 20;

    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);
    // channel.play(500, time);
    // channel.play(1000, time);

    let msg = Message::new().data("Hello world!");
    channel.send(&msg, 100);
}

examples/wav_export/main.rs (lines 4-9)

fn main() {
    let msg = Message::new().data(
        "Peter Piper picked a peck of pickled peppers
A peck of pickled peppers Peter Piper picked
If Peter Piper picked a peck of pickled peppers
Where's the peck of pickled peppers Peter Piper picked?",
    );

    let time = 100;

    let fsk256 = MFSK::new(256).base_frequency(100).delta_frequency(30);
    let channel256 = Sound::new(&fsk256);
    channel256.export_wav(&msg, "examples/wav_export/audio/256fsk.wav", time);

    let fsk16 = MFSK::new(16).base_frequency(100).delta_frequency(100);
    let channel16 = Sound::new(&fsk16);
    channel16.export_wav(&msg, "examples/wav_export/audio/16fsk.wav", time);

    let qam256 = MQAM::new(256, 1000);
    let channel256 = Sound::new(&qam256);
    channel256.export_wav(&msg, "examples/wav_export/audio/256qam.wav", time);

    let qam16 = MQAM::new(16, 1000);
    let channel16 = Sound::new(&qam16);
    channel16.export_wav(&msg, "examples/wav_export/audio/16qam.wav", time);
}

pub fn data_from_binary(self, data: &str) -> Message

Set the data of the message as a binary.

pub fn header(self, header: &str) -> Message

Set the header of the message.

Examples found in repository

examples/message/main.rs (line 4)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

pub fn header_from_binary(self, header: &str) -> Message

Set the header of the message as a binary.

pub fn get_data(&self) -> &str

Get the data of the message as binary.

pub fn get_header(&self) -> &str

Get the header of the message as binary.

pub fn bit_size(&self) -> u32

Get the total amount of bits in the message.

Examples found in repository

examples/message/main.rs (line 6)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

examples/huffman_coding/main.rs (line 12)

fn main() {
    let small_msg = Message::from_string("Hello world!", "HEADER");
    let encoder = HuffmanCoding::from_message(&small_msg);
    let small_enc = encoder.encode(&small_msg);
    let small_dec = encoder.decode(&small_enc, 0);
    println!("{}", encoder);
    println!("{} -> DECODED : {}", small_msg, small_dec);
    println!(
        "\n=== SIZES ===\n{} b -> ENCODED : {} b -> DECODED : {} b",
        small_msg.bit_size(),
        small_enc.bit_size(),
        small_dec.bit_size()
    );

    println!("\n\n");

    let msg1 = Message::from_string(
        "Peter Piper picked a peck of pickled peppers
    A peck of pickled peppers Peter Piper picked
    If Peter Piper picked a peck of pickled peppers
    Where's the peck of pickled peppers Peter Piper picked?",
        "THIS IS A TEST HEADER",
    );
    let encoder1 = HuffmanCoding::from_message(&msg1);
    let msg1_enc = encoder1.encode(&msg1);
    let msg1_dec = encoder1.decode(&msg1_enc, 0);
    println!("{}", encoder);
    println!("{} -> DECODED : {}", msg1, msg1_dec);
    println!(
        "\n=== SIZES ===\n{} b -> ENCODED : {} b -> DECODED : {} b",
        msg1.bit_size(),
        msg1_enc.bit_size(),
        msg1_dec.bit_size()
    );
}

pub fn data_size(&self) -> u32

Get the amount of bits in the data part of the message.

pub fn header_size(&self) -> u32

Get the amount of bits in the header part of the message.

pub fn group_string(message: &String, num: u32) -> Vec<String>

Group a string in packets of a given size.

pub fn group(&self, num: u32) -> Vec<String>

Group the message in packets of the given size.

pub fn group_data(&self, num: u32) -> Vec<String>

Group the data in packets of the given size.

pub fn group_header(&self, num: u32) -> Vec<String>

Group the header in packets of the given size.

pub fn as_u8_array(&self) -> Vec<u8>

Get the message as an array of 8-bit integers.

pub fn data_as_u8_array(&self) -> Vec<u8>

Get the data as an array of 8-bit integers.

pub fn header_as_u8_array(&self) -> Vec<u8>

Get the header as an array of 8-bit integers.

pub fn as_binary(&self) -> &str

Get the message as a binary string.

pub fn data_as_binary(&self) -> &str

Get the data as a binary string.

pub fn header_as_binary(&self) -> &str

Get the header as a binary string.

pub fn as_string(&self) -> String

Get the message as a decoded string.

pub fn data_as_string(&self) -> String

Get the data as a decoded string.

Examples found in repository

examples/message/main.rs (line 8)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

pub fn header_as_string(&self) -> String

Get the header as a decoded string.

Examples found in repository

examples/message/main.rs (line 7)

fn main() {
    let msg = Message::new().data(&"Hello world!").header(&"HEADER");
    println!("MESSAGE {}", msg);
    println!("BIT SIZE {}", msg.bit_size());
    println!("HEADER {}", msg.header_as_string());
    println!("DATA {}", msg.data_as_string());
}

Trait Implementations

impl Display for Message

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

Formats the value using the given formatter.