Struct HistoryInfo 

pub struct HistoryInfo(/* private fields */);

Parsed History-Info header value (RFC 7044).

Contains one or more routing-chain entries, each with a SIP URI, optional index, and optional embedded Reason header.

use sip_header::HistoryInfo;

let raw = "<sip:alice@esrp.example.com>;index=1,<sip:sos@psap.example.com>;index=1.1";
let hi = HistoryInfo::parse(raw).unwrap();
assert_eq!(hi.len(), 2);
assert_eq!(hi.entries()[0].index(), Some("1"));
assert_eq!(hi.entries()[1].index(), Some("1.1"));

Implementations

impl HistoryInfo

pub fn parse(raw: &str) -> Result<HistoryInfo, HistoryInfoError>

Parse a standard comma-separated History-Info header value (RFC 7044).

pub fn from_entries<'a>( entries: impl IntoIterator<Item = &'a str>, ) -> Result<HistoryInfo, HistoryInfoError>

Build from pre-split header entries.

Each entry should be a single <uri>;params string. Use this when entries have already been split by an external mechanism.

pub fn entries(&self) -> &[HistoryInfoEntry]

The parsed entries as a slice.

pub fn into_entries(self) -> Vec<HistoryInfoEntry>

Consume self and return the entries as a Vec.

pub fn len(&self) -> usize

Number of entries.

pub fn is_empty(&self) -> bool

Returns true if there are no entries.

Trait Implementations

impl Clone for HistoryInfo

fn clone(&self) -> HistoryInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for HistoryInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a HistoryInfo

type Item = &'a HistoryInfoEntry

The type of the elements being iterated over.

type IntoIter = Iter<'a, HistoryInfoEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a HistoryInfo as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for HistoryInfo

type Item = HistoryInfoEntry

The type of the elements being iterated over.

type IntoIter = IntoIter<HistoryInfoEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <HistoryInfo as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for HistoryInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HistoryInfo

impl StructuralPartialEq for HistoryInfo