Struct sbd::mo::Message

pub struct Message { /* fields omitted */ }

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

Messages can be ordered by time of session.

Implementations

impl Message

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();

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();

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]);

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();

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();

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();

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();

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();

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();

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();

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);

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 Ord for Message

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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 PartialOrd<Message> for Message

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message