Struct sbd::mo::Message

source ·

pub struct Message { /* private fields */ }

Expand description

Error returned when there is no A mobile-origined Iridium SBD message.

Messages can be ordered by time of session.

Implementations§

source §

impl Message

source

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Message, Error>

Reads in a message from a file path.

Examples

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

source

pub fn read_from<R: Read>(read: R) -> Result<Message, Error>

Reads in a message from an object that implements Read.

Per the specification, oversized and undersized messages will result in an error.

Examples

use std::fs::File;
use sbd::mo::Message;
let mut file = File::open("data/0-mo.sbd").unwrap();
let message = Message::read_from(file).unwrap();

source

pub fn new<I: IntoIterator<Item = InformationElement>>( iter: I ) -> Result<Message, Error>

Creates a new message from information elements.

Examples

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

source

pub fn auto_id(&self) -> u32

Returns this message’s auto id.

Examples

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

source

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::mo::Message;
let message = Message::from_path("data/0-mo.sbd").unwrap();
let imei = message.imei();

source

pub fn session_status(&self) -> SessionStatus

Returns this message’s session status.

Examples

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

source

pub fn momsn(&self) -> u16

Returns this message’s mobile originated message sequence number.

Examples

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

source

pub fn mtmsn(&self) -> u16

Returns this message’s mobile terminated message sequence number.

Examples

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

source

pub fn time_of_session(&self) -> DateTime<Utc>

Returns this message’s time of session.

Examples

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

source

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

Returns this message’s payload.

Examples

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

source

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

Write this message back to a object that can Write.

Examples

use std::io::Cursor;
use sbd::mo::Message;
let message = Message::from_path("data/0-mo.sbd").unwrap();
let mut cursor = Cursor::new(Vec::new());
message.write_to(&mut cursor);