Struct SipPassthroughHeader 

pub struct SipPassthroughHeader { /* private fields */ }

A FreeSWITCH SIP passthrough header variable name.

Combines a SipHeaderPrefix (direction/method) with a SIP header name to produce the channel variable name used on the wire. Use with HeaderLookup::variable() for lookups, or insert into Variables for originate commands.

Typed constructors (known SIP headers)

use freeswitch_types::variables::{SipPassthroughHeader, SipHeaderPrefix};
use sip_header::SipHeader;

let h = SipPassthroughHeader::request(SipHeader::CallInfo);
assert_eq!(h.as_str(), "sip_h_Call-Info");

let h = SipPassthroughHeader::invite(SipHeader::CallInfo);
assert_eq!(h.as_str(), "sip_i_call_info");

Raw constructors (custom headers)

use freeswitch_types::variables::SipPassthroughHeader;

let h = SipPassthroughHeader::request_raw("X-Tenant").unwrap();
assert_eq!(h.as_str(), "sip_h_X-Tenant");

Implementations

impl SipPassthroughHeader

pub fn new(prefix: SipHeaderPrefix, header: SipHeader) -> Self

Create from a prefix and a known SipHeader.

pub fn new_raw( prefix: SipHeaderPrefix, name: impl Into<String>, ) -> Result<Self, InvalidHeaderName>

Create from a prefix and an arbitrary header name.

Returns Err if the name contains \n or \r (wire injection risk).

pub fn invite(header: SipHeader) -> Self

Incoming INVITE header (sip_i_*).

pub fn invite_raw(name: impl Into<String>) -> Result<Self, InvalidHeaderName>

Incoming INVITE header from raw name.

pub fn request(header: SipHeader) -> Self

Outgoing request header (sip_h_*).

pub fn request_raw(name: impl Into<String>) -> Result<Self, InvalidHeaderName>

Outgoing request header from raw name.

pub fn response(header: SipHeader) -> Self

Outgoing response header (sip_rh_*).

pub fn response_raw(name: impl Into<String>) -> Result<Self, InvalidHeaderName>

Outgoing response header from raw name.

pub fn provisional(header: SipHeader) -> Self

Provisional response header (sip_ph_*).

pub fn provisional_raw( name: impl Into<String>, ) -> Result<Self, InvalidHeaderName>

Provisional response header from raw name.

pub fn bye(header: SipHeader) -> Self

BYE request header (sip_bye_h_*).

pub fn bye_raw(name: impl Into<String>) -> Result<Self, InvalidHeaderName>

BYE request header from raw name.

pub fn no_bye(header: SipHeader) -> Self

Suppress header on BYE (sip_nobye_h_*).

pub fn no_bye_raw(name: impl Into<String>) -> Result<Self, InvalidHeaderName>

Suppress header on BYE from raw name.

pub fn prefix(&self) -> SipHeaderPrefix

The prefix (direction/method) of this variable.

pub fn canonical_name(&self) -> &str

The canonical SIP header name (e.g. "Call-Info", "X-Tenant").

pub fn as_str(&self) -> &str

The pre-computed wire variable name (e.g. "sip_h_Call-Info").

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

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

Delegates to sip_header::extract_header() using the canonical name.

pub fn is_array_header(&self) -> bool

Whether this header may contain ARRAY-encoded values when read from FreeSWITCH.

Only meaningful for the Invite prefix — FreeSWITCH stores multi-valued incoming SIP headers in ARRAY::val1|:val2 format. For other prefixes (which are write-only), this always returns false.

Trait Implementations

impl AsRef<str> for SipPassthroughHeader

fn as_ref(&self) -> &str

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

impl Clone for SipPassthroughHeader

fn clone(&self) -> SipPassthroughHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipPassthroughHeader

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

Formats the value using the given formatter.

impl Display for SipPassthroughHeader

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

Formats the value using the given formatter.

impl From<SipPassthroughHeader> for String

fn from(h: SipPassthroughHeader) -> Self

Converts to this type from the input type.

impl FromStr for SipPassthroughHeader

type Err = ParseSipPassthroughError

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 SipPassthroughHeader

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 SipPassthroughHeader

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

fn as_str(&self) -> &str

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

impl Eq for SipPassthroughHeader

impl StructuralPartialEq for SipPassthroughHeader