Struct sbd_lib::sbd_message::Message

pub struct Message { /* fields omitted */ }

A Iridium SBD message.

Implementations

impl Message

pub fn header(&self) -> &dyn SbdHeader

Returns this message's header.

pub fn payload(&self) -> &[u8]

Returns this message's payload.

Examples

use sbd_lib::Message;
let message = Message::from_path("data/0-mo.sbd").unwrap();
let payload = message.payload();

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Create message from Path

pub fn read_from<R: Read>(read: R) -> Result<Self>

Create message from Read

pub fn new(
    header: Header,
    payload: Vec<u8>,
    location: Option<LocationInformation>,
    ie: Vec<InformationElement>
) -> Self

pub fn create<I: IntoIterator<Item = InformationElement>>(
    iter: I
) -> Result<Self>

Creates a new message from information elements.

Examples

use chrono::{Utc, TimeZone};
use sbd_lib::mo;
use sbd_lib::{InformationElement, Header, Message};
let header = InformationElement::Header(mo::Header {
    auto_id: 1,
    imei: [0; 15],
    session_status: mo::SessionStatus::Ok,
    momsn: 1,
    mtmsn: 0,
    time_of_session: Utc.ymd(2017, 10, 1).and_hms(0, 0, 0),
}.into());
let payload = InformationElement::MOPayload(Vec::new());
let message = Message::create(vec![header, payload]);

pub fn imei(&self) -> &str

Returns this message's imei as a string.

Panics

Panics if the IMEI number is not valid utf8. The specification says that IMEIs should be ascii numbers.

Examples

use sbd_lib::Message;
let message = Message::from_path("data/0-mo.sbd").unwrap();
let imei = message.imei();

pub fn write_to<W: Write>(&self, write: W) -> Result<()>

Write this message back to a object that can Write.

Examples

use sbd_lib::Message;
let message = Message::from_path("data/0-mo.sbd").unwrap();
let mut buff = vec![];
message.write_to(&mut buff);

pub fn location(&self) -> &Option<LocationInformation>

Returns this message's location.

pub fn information_elements(&self) -> &[InformationElement]

Returns this message's information_elements.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

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

Formats the value using the given formatter.

impl Eq for Message

impl From<Header> for Message

fn from(header: Header) -> Message

Performs the conversion.

impl PartialEq<Message> for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl StructuralEq for Message

impl StructuralPartialEq for Message