Struct CmcdProcessor

pub struct CmcdProcessor {
    fields: Fields,
    ignore_missing: bool,
}

Common Media Client Data Specification: https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf

The data payload for Header and Query Argument transmission consists of a series of key/value pairs constructed according to the following rules:

1. All information in the payload MUST be represented as = pairs.
2. The key and value MUST be separated by an equals sign Unicode 0x3D. If the value type is BOOLEAN and the value is TRUE, then the equals sign and the value MUST be omitted.
3. Successive key/value pairs MUST be delimited by a comma Unicode 0x2C.
4. The key names described in this specification are reserved. Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
5. If headers are used for data transmission, then custom keys SHOULD be allocated to one of the four defined header names based upon their expected level of variability: a. CMCD-Request: keys whose values vary with each request. b. CMCD-Object: keys whose values vary with the object being requested. c. CMCD-Status: keys whose values do not vary with every request or object. d. CMCD-Session: keys whose values are expected to be invariant over the life of the session.
6. All key names are case-sensitive.
7. Any value of type String MUST be enclosed by opening and closing double quotes Unicode 0x22. Double quotes and backslashes MUST be escaped using a backslash “" Unicode 0x5C character. Any value of type Token does not require quoting.
8. All keys are OPTIONAL.
9. Key-value pairs SHOULD be sequenced in alphabetical order of the key name in order to reduce the fingerprinting surface exposed by the player.
10. If the data payload is transmitted as a query argument, then the entire payload string MUST be URLEncoded per [5]. Data payloads transmitted via headers MUST NOT be URLEncoded.
11. The data payload syntax is intended to be compliant with Structured Field Values for HTTP [6].
12. Transport Layer Security SHOULD be used to protect all transmission of CMCD data.

Fields

fields: Fields

ignore_missing: bool

Implementations

impl CmcdProcessor

fn generate_key(prefix: &str, key: &str) -> String

fn parse(&self, name: &str, value: &str) -> Result<PipelineMap>

Trait Implementations

impl Debug for CmcdProcessor

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

Formats the value using the given formatter.

impl Default for CmcdProcessor

fn default() -> CmcdProcessor

Returns the “default value” for a type.

impl From<CmcdProcessor> for ProcessorKind

fn from(v: CmcdProcessor) -> ProcessorKind

Converts to this type from the input type.

impl Processor for CmcdProcessor

fn kind(&self) -> &str

Get the processor’s kind

fn ignore_missing(&self) -> bool

Whether to ignore missing

fn exec_mut(&self, val: &mut PipelineMap) -> Result<()>

Execute the processor on a vector which be preprocessed by the pipeline

impl TryFrom<&LinkedHashMap<Yaml, Yaml>> for CmcdProcessor

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Hash) -> Result<Self>

Performs the conversion.

impl TryInto<CmcdProcessor> for ProcessorKind

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<CmcdProcessor, <Self as TryInto<CmcdProcessor>>::Error>

Performs the conversion.