Struct CodecStringEntry 

pub struct CodecStringEntry { /* private fields */ }

A single entry in a FreeSWITCH codec string.

All fields are private. Use CodecStringEntry::new plus the with_* builder methods to construct, and the read accessors plus Display to inspect and emit.

Implementations

impl CodecStringEntry

pub fn new(name: impl Into<String>) -> Result<Self, CodecStringError>

Create a new entry with the given codec name.

Returns CodecStringError::InvalidCodecName if the name is empty, CodecStringError::WireInjection if it contains \n or \r, or CodecStringError::InvalidCharInName if it contains any codec-string grammar delimiter (, @ ~ . ' \ or ASCII whitespace).

pub fn with_module( self, modname: impl Into<String>, ) -> Result<Self, CodecStringError>

Set the module prefix (e.g. "mod_opus").

Returns CodecStringError::WireInjection if the value contains \n or \r, or CodecStringError::InvalidCharInName if it contains a grammar delimiter.

pub fn with_fmtp( self, fmtp: impl Into<String>, ) -> Result<Self, CodecStringError>

Set format parameters (~fmtp in the grammar).

Errors

• CodecStringError::AtInFmtp — @ is unrepresentable in fmtp (the @ split precedes the ~ split in FreeSWITCH’s parser).
• CodecStringError::DotInFmtpWithoutModule — a . in fmtp without a module prefix becomes the module-name boundary; the codec is silently dropped. Set the module prefix first with with_module.
• CodecStringError::WireInjection — \n or \r can inject ESL commands.

pub fn with_rate(self, rate: u32) -> Self

Set the sample rate qualifier (@<n>h).

pub fn with_ptime(self, ptime: u32) -> Self

Set the ptime qualifier (@<n>i).

pub fn with_bitrate(self, bitrate: u32) -> Self

Set the bitrate qualifier (@<n>b).

pub fn with_channels(self, channels: u32) -> Self

Set the channel count qualifier (@<n>c).

FreeSWITCH reads this as atoi into a uint32_t; the field is u32 here to match. SdpCodec::channels stays Option<u8> (from a=rtpmap, realistically tiny) and widens losslessly at the merge boundary.

pub fn modname(&self) -> Option<&str>

The module prefix, if any (e.g. "mod_opus").

pub fn name(&self) -> &str

The codec encoding name (e.g. "PCMU", "opus", "AMR-WB").

pub fn fmtp(&self) -> Option<&str>

The format parameters, if any.

pub fn rate(&self) -> Option<u32>

The sample rate qualifier, if any.

pub fn rate_mut(&mut self) -> &mut Option<u32>

Mutable access to the rate qualifier.

pub fn ptime(&self) -> Option<u32>

The ptime qualifier in milliseconds, if any.

pub fn ptime_mut(&mut self) -> &mut Option<u32>

Mutable access to the ptime qualifier.

pub fn bitrate(&self) -> Option<u32>

The bitrate qualifier in bits/s, if any.

pub fn bitrate_mut(&mut self) -> &mut Option<u32>

Mutable access to the bitrate qualifier.

pub fn channels(&self) -> Option<u32>

The channel count qualifier, if any.

pub fn channels_mut(&mut self) -> &mut Option<u32>

Mutable access to the channel count qualifier.

pub fn set_name( &mut self, name: impl Into<String>, ) -> Result<(), CodecStringError>

Set or replace the codec encoding name.

Returns CodecStringError::InvalidCodecName if empty, CodecStringError::WireInjection if the value contains \n or \r, or CodecStringError::InvalidCharInName if it contains a grammar delimiter.

pub fn set_module( &mut self, modname: impl Into<String>, ) -> Result<(), CodecStringError>

Set or replace the module prefix.

Returns CodecStringError::WireInjection if the value contains \n or \r, or CodecStringError::InvalidCharInName if it contains a grammar delimiter.

pub fn set_fmtp( &mut self, fmtp: impl Into<String>, ) -> Result<(), CodecStringError>

Set or replace the format parameters (~fmtp).

Returns the same errors as with_fmtp.

pub fn clear_fmtp(&mut self)

Clear the format parameters.

pub fn clear_module(&mut self) -> Result<(), CodecStringError>

Clear the module prefix.

Returns CodecStringError::DotInFmtpWithoutModule if the current fmtp contains a . — removing the prefix would make the entry re-parse with the dot as the module boundary, silently dropping the codec. The entry is left unchanged on error.

pub fn clear_rate(&mut self)

Clear the rate qualifier.

Infallible analog to clear_fmtp; use to strip a qualifier that matched no loaded implementation (see CodecString::qualified).

pub fn clear_ptime(&mut self)

Clear the ptime qualifier.

Infallible analog to clear_fmtp; use to strip a qualifier that matched no loaded implementation (see CodecString::qualified).

pub fn clear_bitrate(&mut self)

Clear the bitrate qualifier.

Infallible analog to clear_fmtp; use to strip a qualifier that matched no loaded implementation (see CodecString::qualified).

pub fn clear_channels(&mut self)

Clear the channel count qualifier.

Infallible analog to clear_fmtp; use to strip a qualifier that matched no loaded implementation (see CodecString::qualified).

pub fn simplify(&mut self)

Drop qualifiers whose value already equals the FreeSWITCH default for this codec (default_rate/default_ptime, ported from switch_core.c:2033-2055), leaving bitrate alone. G.722 is exempt entirely.

Precondition: only safe on an entry that already matched a loaded implementation, e.g. one that survived CodecString::retain_available — stripping compares against a per-name table, not against what an implementation registered, so it can make an unmatched qualifier start matching. Both that and the G.722 carve-out are in docs/codec-string-format.md.

Trait Implementations

impl Clone for CodecStringEntry

fn clone(&self) -> CodecStringEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecStringEntry

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

Formats the value using the given formatter.

impl Display for CodecStringEntry

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

Formats the value using the given formatter.

impl Eq for CodecStringEntry

impl Extend<CodecStringEntry> for CodecString

fn extend<I: IntoIterator<Item = CodecStringEntry>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<CodecStringEntry> for CodecString

fn from_iter<I: IntoIterator<Item = CodecStringEntry>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for CodecStringEntry

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

Parse a single codec-string entry from a string.

Reuses the same escape/quote-aware split as CodecString’s parser, then delegates to the same single-entry parser. A top-level (unescaped) comma is CodecStringError::MultipleEntries, not a silent take-first.

type Err = CodecStringError

The associated error which can be returned from parsing.

impl PartialEq for CodecStringEntry

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodecStringEntry