Struct lib_tcstring::TCModelV1

pub struct TCModelV1 {
    pub created_at: u64,
    pub updated_at: u64,
    pub cmp_id: u16,
    pub cmp_version: u16,
    pub consent_screen: u8,
    pub consent_lang: String,
    pub vendor_list_version: u16,
    pub purposes_consent: Vec<u8>,
    pub vendors: VendorSet,
}

TCModelV1 contains all relevant fields specified in the Vendor Consent String Format V1 except for the Version field which is omitted

Field mapping

• Created -> created_at
• LastUpdated -> updated_at
• CmpId -> cmp_id
• CmpVersion -> cmp_version
• ConsentScreen -> consent_screen
• ConsentLanguage -> consent_lang
• VendorListVersion -> vendor_list_version
• PurposesAllowed -> purposes_consent
• VendorConsents -> vendors

use std::convert::TryFrom;
// will return a Result which contains either the TCModel or an Error
// if the TCString could not be parsed or the TCString includes an unsupported version
let tc_model = lib_tcstring::TCModelV1::try_from("BOEFEAyOEFEAyAHABDENAI4AAAB9vABAASA");

Fields

created_at: u64

Epoch milliseconds when consent string was first created

updated_at: u64

Epoch milliseconds when consent string was last updated

cmp_id: u16

Consent Manager Provider ID that last updated the consent string

cmp_version: u16

Consent Manager Provider version

consent_screen: u8

Screen number in the CMP where consent was given

consent_lang: String

ISO 639-1 language code in which the CMP UI was presented

vendor_list_version: u16

Version of vendor list used in most recent consent string update

purposes_consent: Vec<u8>

List of permitted purposes

vendors: VendorSet

List of allowed or blocked vendors

See VendorSet for more details

Trait Implementations

impl Clone for TCModelV1

fn clone(&self) -> TCModelV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TCModelV1

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

Formats the value using the given formatter.

impl Default for TCModelV1

fn default() -> TCModelV1

Returns the "default value" for a type.

impl Hash for TCModelV1

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<TCModelV1> for TCModelV1

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TCModelV1> for TCModelV1

fn partial_cmp(&self, other: &TCModelV1) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TCModelV1) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TCModelV1) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TCModelV1) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TCModelV1) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for TCModelV1

impl<'_> TryFrom<&'_ str> for TCModelV1

type Error = TcsError

The type returned in the event of a conversion error.

fn try_from(val: &str) -> Result<Self, TcsError>

Performs the conversion.