Struct SipPassthroughHeader

Source

pub struct SipPassthroughHeader { /* private fields */ }

Expand description

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§

Source §

impl SipPassthroughHeader

Source

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

Create from a prefix and a known SipHeader.

Source

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).

Source

pub fn invite(header: SipHeader) -> Self

Incoming INVITE header (sip_i_*).

Source

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

Incoming INVITE header from raw name.

Source

pub fn request(header: SipHeader) -> Self

Outgoing request header (sip_h_*).

Source

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

Outgoing request header from raw name.

Source

pub fn response(header: SipHeader) -> Self

Outgoing response header (sip_rh_*).

Source

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

Outgoing response header from raw name.

Source

pub fn provisional(header: SipHeader) -> Self

Provisional response header (sip_ph_*).

Source

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

Provisional response header from raw name.

Source

pub fn bye(header: SipHeader) -> Self

BYE request header (sip_bye_h_*).

Source

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

BYE request header from raw name.

Source

pub fn no_bye(header: SipHeader) -> Self

Suppress header on BYE (sip_nobye_h_*).

Source

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

Suppress header on BYE from raw name.

Source

pub fn prefix(&self) -> SipHeaderPrefix

The prefix (direction/method) of this variable.

Source

pub fn canonical_name(&self) -> &str

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

Source

pub fn as_str(&self) -> &str

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

Source

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.

Source

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.