Enum SipInviteHeader 

#[non_exhaustive]
pub enum SipInviteHeader {
    From,
    To,
    CallId,
    Cseq,
    Identity,
    Route,
    MaxForwards,
    ProxyRequire,
    Contact,
    UserAgent,
    Subject,
    Priority,
    Organization,
    InReplyTo,
    AcceptEncoding,
    AcceptLanguage,
    Allow,
    Require,
    Supported,
    Date,
    Timestamp,
    Expires,
    MinExpires,
    SessionExpires,
    MinSe,
    Privacy,
    MimeVersion,
    ContentType,
    ContentEncoding,
    ContentLanguage,
    ContentDisposition,
    ContentLength,
    Via,
    RecordRoute,
    ProxyAuthorization,
    CallInfo,
    Accept,
    Authorization,
    AlertInfo,
    PAssertedIdentity,
    PPreferredIdentity,
    RemotePartyId,
    ReplyTo,
}

Raw SIP INVITE headers preserved verbatim as channel variables.

Set by sofia_parse_all_invite_headers() when the sofia profile has parse-all-invite-headers enabled. Access via HeaderLookup::variable().

Variants marked “ARRAY” may contain multiple values in ARRAY::val1|:val2 format when the SIP message has repeated headers. Parse with EslArray. Variants marked “single” contain one serialized header value.

For headers not covered by this enum (dynamic unknown headers stored as sip_i_<lowercased_name>), use variable_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

From

SIP From header.

To

SIP To header.

CallId

SIP Call-ID header.

Cseq

SIP CSeq header.

Identity

SIP Identity header (RFC 8224).

Route

SIP Route header.

MaxForwards

SIP Max-Forwards header.

ProxyRequire

SIP Proxy-Require header.

Contact

SIP Contact header.

UserAgent

SIP User-Agent header.

Subject

SIP Subject header.

Priority

SIP Priority header.

Organization

SIP Organization header.

InReplyTo

SIP In-Reply-To header.

AcceptEncoding

SIP Accept-Encoding header.

AcceptLanguage

SIP Accept-Language header.

Allow

SIP Allow header.

Require

SIP Require header.

Supported

SIP Supported header.

Date

SIP Date header.

Timestamp

SIP Timestamp header.

Expires

SIP Expires header.

MinExpires

SIP Min-Expires header.

SessionExpires

SIP Session-Expires header.

MinSe

SIP Min-SE header.

Privacy

SIP Privacy header.

MimeVersion

SIP MIME-Version header.

ContentType

SIP Content-Type header.

ContentEncoding

SIP Content-Encoding header.

ContentLanguage

SIP Content-Language header.

ContentDisposition

SIP Content-Disposition header.

ContentLength

SIP Content-Length header.

Via

SIP Via headers. ARRAY when multiple hops present.

RecordRoute

SIP Record-Route headers. ARRAY when multiple proxies present.

ProxyAuthorization

SIP Proxy-Authorization headers. ARRAY when multiple credentials present.

CallInfo

SIP Call-Info headers. ARRAY when multiple info URIs present.

Accept

SIP Accept headers. ARRAY when multiple media types present.

Authorization

SIP Authorization headers. ARRAY when multiple credentials present.

AlertInfo

SIP Alert-Info headers. ARRAY when multiple alert URIs present.

PAssertedIdentity

SIP P-Asserted-Identity headers. ARRAY when multiple identities present (RFC 3325).

PPreferredIdentity

SIP P-Preferred-Identity headers. ARRAY when multiple identities present.

RemotePartyId

SIP Remote-Party-ID headers. ARRAY when multiple identities present.

ReplyTo

SIP Reply-To headers. ARRAY when multiple reply addresses present.

Implementations

impl SipInviteHeader

pub fn as_str(&self) -> &'static str

Canonical protocol string.

impl SipInviteHeader

pub const ARRAY_HEADERS: &[SipInviteHeader]

Headers that may contain multiple values in ARRAY format.

pub fn is_array_header(&self) -> bool

Whether this header may contain multiple values in ARRAY format.

pub fn header_name(&self) -> &'static str

Canonical SIP header name (e.g. "From", "Call-ID").

pub fn extract_from(&self, message: &str) -> Option<String>

Extract this header’s value from a raw SIP message.

Delegates to extract_header using the canonical name from header_name().

Trait Implementations

impl AsRef<str> for SipInviteHeader

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SipInviteHeader

fn clone(&self) -> SipInviteHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipInviteHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SipInviteHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SipInviteHeader

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

Formats the value using the given formatter.

impl FromStr for SipInviteHeader

type Err = ParseSipInviteHeaderError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SipInviteHeader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SipInviteHeader

fn eq(&self, other: &SipInviteHeader) -> 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 Serialize for SipInviteHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VariableName for SipInviteHeader

fn as_str(&self) -> &str

Wire-format variable name (e.g. "sip_call_id").

impl Copy for SipInviteHeader

impl Eq for SipInviteHeader

impl StructuralPartialEq for SipInviteHeader