imsg-formats 0.4.0

Parsed representations of Bluetooth MAP and PBAP wire formats
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

//! bMessage encoder and parser (MAP spec appendix B).
//!
//! Parse with [`crate::bmessage::BMessage::parse`]; encode with
//! [`crate::bmessage::BMessage::encode`].

mod encode;
mod parser;
mod types;

pub use types::{BBody, BEnvelope, BMessage, BMessageError, BVCard, MessageStatus, MessageType};

// LENGTH covers the CRLF `BEGIN:MSG…END:MSG` block; encode and parse must agree on its overhead.
const BEGIN_MSG_LEN: usize = "BEGIN:MSG\r\n".len();
const END_MSG_LEN: usize = "END:MSG\r\n".len();

impl BMessage {
    /// Parses a bMessage from UTF-8 text, accepting CRLF and LF line endings.
    ///
    /// # Errors
    ///
    /// Returns [`BMessageError`] when a required field is absent, a section is
    /// unterminated, or STATUS/TYPE hold unrecognised values.
    pub fn parse(input: &str) -> Result<Self, BMessageError> {
        parser::parse_bmessage(input)
    }
}