Struct cea708_types::Service

source ·

pub struct Service { /* private fields */ }

Expand description

A Service in a DTVCCPacket

As specified in CEA-708, there can be a maximum of 63 services. Service 1 is the primary caption service and Service 2 is the secondary caption service. All other services are undefined.

Implementations§

source §

impl Service

source

pub fn new(service_no: u8) -> Self

Create a new Service

§Panics

if number >= 64

source

pub fn number(&self) -> u8

Returns the number of this Service

§Examples

let mut service = Service::new(1);
assert_eq!(service.number(), 1);

source

pub fn free_space(&self) -> usize

The amount of free space (in bytes) that can by placed inside this Service block

§Examples

let service = Service::new(1);
assert_eq!(service.free_space(), 31);

source

pub fn len(&self) -> usize

The length in bytes of this Service block

§Examples

let mut service = Service::new(1);
assert_eq!(service.len(), 0);
service.push_code(&Code::LatinCapitalA).unwrap();
assert_eq!(service.len(), 2);
service.push_code(&Code::LatinCapitalB).unwrap();
assert_eq!(service.len(), 3);

source

pub fn push_code(&mut self, code: &Code) -> Result<(), WriterError>

Push a tables::Code to the end of this Service

§Errors

WriterError::ReadOnly if Service is number 0 (called the NULL Service)
WriterError::WouldOverflow if adding the tables::Code would cause to Service to overflow

§Examples

let mut service = Service::new(1);
service.push_code(&Code::LatinCapitalA).unwrap();

source

pub fn parse(data: &[u8]) -> Result<Self, ParserError>

Parse a Service from a set of bytes

§Errors

ParserError::LengthMismatch if the length of the data is less than the size advertised in the header

§Examples

let bytes = [0x21, 0x41];
let service = Service::parse(&bytes).unwrap();
assert_eq!(service.number(), 1);
assert_eq!(service.codes()[0], Code::LatinCapitalA);

source

pub fn codes(&self) -> &[Code]

The ordered list of tables::Codes present in this Service block

§Examples

let mut service = Service::new(1);
service.push_code(&Code::LatinCapitalA).unwrap();
let codes = service.codes();
assert_eq!(codes, [Code::LatinCapitalA]);

source

pub fn write<W: Write>(&self, w: &mut W) -> Result<(), Error>

Write the Service block to a byte stream

§Examples

let mut service = Service::new(1);
service.push_code(&Code::LatinCapitalA).unwrap();
let mut written = vec![];
service.write(&mut written);
let expected = [0x21, 0x41];
assert_eq!(written, expected);