Trait SipHeaderLookup

Source

pub trait SipHeaderLookup {
Show 36 methods    // Required method
    fn sip_header_str(&self, name: &str) -> Option<&str>;

    // Provided methods
    fn sip_header(&self, name: SipHeader) -> Option<&str> { ... }
    fn sip_header_all_str<'a>(&'a self, name: &str) -> Vec<&'a str> { ... }
    fn sip_header_all(&self, name: SipHeader) -> Vec<&str> { ... }
    fn call_info(&self) -> Result<Option<UriInfo>, UriInfoError> { ... }
    fn history_info(&self) -> Result<Option<HistoryInfo>, HistoryInfoError> { ... }
    fn p_asserted_identity(
        &self,
    ) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn p_preferred_identity(
        &self,
    ) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn route(&self) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn record_route(
        &self,
    ) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn path(&self) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn service_route(
        &self,
    ) -> Result<Vec<SipHeaderAddr>, ParseSipHeaderAddrError> { ... }
    fn contact(&self) -> Result<Vec<ContactValue>, ParseSipHeaderAddrError> { ... }
    fn alert_info(&self) -> Result<Option<UriInfo>, UriInfoError> { ... }
    fn error_info(&self) -> Result<Option<UriInfo>, UriInfoError> { ... }
    fn allow(&self) -> Vec<&str> { ... }
    fn supported(&self) -> Vec<&str> { ... }
    fn require_header(&self) -> Vec<&str> { ... }
    fn proxy_require(&self) -> Vec<&str> { ... }
    fn unsupported(&self) -> Vec<&str> { ... }
    fn allow_events(&self) -> Vec<&str> { ... }
    fn content_encoding(&self) -> Vec<&str> { ... }
    fn content_language(&self) -> Vec<&str> { ... }
    fn in_reply_to(&self) -> Vec<&str> { ... }
    fn via(&self) -> Result<Option<SipVia>, SipViaError> { ... }
    fn authorization(&self) -> Result<Vec<SipAuthValue>, SipAuthError> { ... }
    fn proxy_authorization(&self) -> Result<Vec<SipAuthValue>, SipAuthError> { ... }
    fn www_authenticate(&self) -> Result<Vec<SipAuthValue>, SipAuthError> { ... }
    fn proxy_authenticate(&self) -> Result<Vec<SipAuthValue>, SipAuthError> { ... }
    fn warning(&self) -> Result<Option<SipWarning>, SipWarningError> { ... }
    fn security_client(&self) -> Result<Option<SipSecurity>, SipSecurityError> { ... }
    fn security_server(&self) -> Result<Option<SipSecurity>, SipSecurityError> { ... }
    fn security_verify(&self) -> Result<Option<SipSecurity>, SipSecurityError> { ... }
    fn accept(&self) -> Result<Option<SipAccept>, SipAcceptError> { ... }
    fn accept_encoding(
        &self,
    ) -> Result<Option<SipAcceptEncoding>, SipAcceptEncodingError> { ... }
    fn accept_language(
        &self,
    ) -> Result<Option<SipAcceptLanguage>, SipAcceptLanguageError> { ... }
}

Expand description

Trait for looking up standard SIP headers from any key-value store.

Implementors provide sip_header_str() and get all typed accessors as default implementations.

§Example

use std::collections::HashMap;
use sip_header::{SipHeaderLookup, SipHeader};

let mut headers = HashMap::new();
headers.insert(
    "Call-Info".to_string(),
    "<urn:emergency:uid:callid:abc>;purpose=emergency-CallId".to_string(),
);

assert_eq!(
    headers.sip_header(SipHeader::CallInfo),
    Some("<urn:emergency:uid:callid:abc>;purpose=emergency-CallId"),
);

let ci = headers.call_info().unwrap().unwrap();
assert_eq!(ci.entries()[0].purpose(), Some("emergency-CallId"));

Required Methods§

Source

fn sip_header_str(&self, name: &str) -> Option<&str>

Look up a SIP header by its canonical name (e.g. "Call-Info").

Provided Methods§

Source

fn sip_header(&self, name: SipHeader) -> Option<&str>

Look up a SIP header by its SipHeader enum variant.

Source

fn sip_header_all_str<'a>(&'a self, name: &str) -> Vec<&'a str>

Return all occurrences of a header by canonical name.

Unlike sip_header_str which returns at most one value, this method returns every occurrence. The default implementation wraps sip_header_str in a single-element Vec; storage backends that preserve per-occurrence values (e.g. HashMap<String, Vec<String>>) should override this.

Source