scte35 0.2.0

A Rust library for creating and parsing SCTE-35 (Society of Cable Telecommunications Engineers) messages with zero-dependency.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Trait definitions for encodable types.

use super::error::EncodingResult;
use super::writer::BitWriter;

#[cfg(feature = "base64")]
use data_encoding::BASE64;

/// Trait for types that can be encoded to SCTE-35 binary format.
pub trait Encodable {
    /// Encode the structure to binary SCTE-35 format.
    fn encode(&self, writer: &mut BitWriter) -> EncodingResult<()>;

    /// Calculate the encoded size in bytes.
    ///
    /// This should return the exact number of bytes that will be written
    /// when `encode` is called. This is used for pre-allocating buffers.
    fn encoded_size(&self) -> usize;

    /// Convenience method to encode to a new byte vector.
    fn encode_to_vec(&self) -> EncodingResult<Vec<u8>> {
        let mut writer = BitWriter::with_capacity(self.encoded_size());
        self.encode(&mut writer)?;
        Ok(writer.finish())
    }
}

/// Extension trait for encoding with CRC support.
#[cfg(feature = "crc-validation")]
pub trait CrcEncodable: Encodable {
    /// Encode with automatic CRC calculation and insertion.
    fn encode_with_crc(&self) -> EncodingResult<Vec<u8>>;
}

/// Extension trait for base64 encoding support.
#[cfg(feature = "base64")]
pub trait Base64Encodable: Encodable {
    /// Encode to base64 string.
    fn encode_base64(&self) -> EncodingResult<String> {
        let bytes = self.encode_to_vec()?;
        Ok(BASE64.encode(&bytes))
    }

    /// Encode with CRC and then to base64.
    #[cfg(feature = "crc-validation")]
    fn encode_base64_with_crc(&self) -> EncodingResult<String>
    where
        Self: CrcEncodable,
    {
        let bytes = self.encode_with_crc()?;
        Ok(BASE64.encode(&bytes))
    }
}