Struct lib_tcstring::TCModelV2

pub struct TCModelV2 {
    pub created_at: u64,
    pub updated_at: u64,
    pub cmp_id: u16,
    pub cmp_version: u16,
    pub consent_screen: u8,
    pub consent_language: String,
    pub vendor_list_version: u16,
    pub tcf_policy_version: u16,
    pub is_service_specific: bool,
    pub use_non_standard_stacks: bool,
    pub special_feature_opt_ins: Vec<u8>,
    pub purpose_consents: Vec<u8>,
    pub purpose_li_transparency: Vec<u8>,
    pub purpose_one_treatment: bool,
    pub publisher_country_code: String,
    pub vendor_consents: Vec<u16>,
    pub vendor_li_consents: Vec<u16>,
    pub publisher_restrictions: Vec<PublisherRestriction>,
    pub disclosed_vendors: Vec<u16>,
    pub allowed_vendors: Vec<u16>,
    pub publisher_purposes_consent: Vec<u8>,
    pub publisher_purposes_li_transparency: Vec<u8>,
    pub custom_purposes_consent: Vec<u8>,
    pub custom_purposes_li_transparency: Vec<u8>,
}

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

Note that the "Core String", "Disclosed Vendors", "Allowed Vendors" and "Publisher TC" segments are mapped into fields

"Core String" field mapping

• Created -> created_at
• LastUpdated -> updated_at
• CmpId -> cmp_id
• CmpVersion -> cmp_version
• ConsentScreen -> consent_screen
• ConsentLanguage -> consent_language
• VendorListVersion -> vendor_list_version
• TcfPolicyVersion -> tcf_policy_version
• IsServiceSpecific -> is_service_specific
• UseNonStandardStacks -> use_non_standard_stacks
• SpecialFeatureOptIns -> special_feature_opt_ins
• PurposesConsent -> purpose_consents
• PurposesLITransparancy -> purpose_li_transparency
• PurposeOneTreatment -> purpose_one_treatment
• PublisherCC -> publisher_country_code
• VendorsConsent -> vendor_consents
• VendorsLIConsent -> vendor_li_consents
• PublisherRestrictions -> publisher_restrictions

"Disclosed Vendors" segment is mapped by the disclosed_vendors field

"Allowed Vendors" segment is mapped by the allowed_vendors field

"Publisher TC" field mapping

• PubPurposesConsent -> publisher_purposes_consent
• PubPurposesLITransparency -> publisher_purposes_li_transparency
• CustomPurposesConsent -> custom_purposes_consent
• CustomPurposesLITransparency -> custom_purposes_li_transparency

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::TCModelV2::try_from("COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA");

Fields

created_at: u64

Epoch milliseconds when this TC String was first created

updated_at: u64

Epoch milliseconds when TC String was last updated

cmp_id: u16

Consent Management Platform ID that last updated the TC String

cmp_version: u16

Consent Management Platform version of the CMP that last updated this TC String

consent_screen: u8

CMP Screen number at which consent was given for a user with the CMP that last updated this TC String

consent_language: String

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

vendor_list_version: u16

Version of the global vendor list used to create this TC String

tcf_policy_version: u16

Version of the corresponding field in the global vendor list that was used for obtaining consent

is_service_specific: bool

Whether the signals encoded in this TC String were from service-specific storage (true) or shared storage (false)

use_non_standard_stacks: bool

true means that a CMP is using customized Stack descriptions and not the standard stack descriptions defined in the Policies (Appendix A, Section E)

false means standard stacks were used

special_feature_opt_ins: Vec<u8>

List of opted-in "Special Features"

"Special Features" are numerically identified in the global vendor list separately from normal features

purpose_consents: Vec<u8>

List of allowed purposes

purpose_li_transparency: Vec<u8>

List of allowed "Legitimate Interest" purposes

purpose_one_treatment: bool

true means "Purpose 1" was not disclosed

false means "Purpose 1" was disclosed commonly as consent

publisher_country_code: String

ISO 3166-1 alpha-2 code

vendor_consents: Vec<u16>

List of allowed vendors

vendor_li_consents: Vec<u16>

List of vendors "Legitimate Interest" disclosures

publisher_restrictions: Vec<PublisherRestriction>

List of publisher restrictions on a per purpose basis

See PublisherRestriction for more details

disclosed_vendors: Vec<u16>

List of vendors that have been disclosed to a given user by a CMP

allowed_vendors: Vec<u16>

List of vendors the publisher permits to use OOB legal bases

publisher_purposes_consent: Vec<u8>

List of purposes which are established on the legal basis of consent, for the publisher

publisher_purposes_li_transparency: Vec<u8>

List of purposes which are established on the legal basis of "Legitimate Interest" and the user has not exercised their “Right to Object”

custom_purposes_consent: Vec<u8>

List of allowed custom purposes, for the publisher

custom_purposes_li_transparency: Vec<u8>

List of custom purposes which are are established on the legal basis of "Legitimate Interest"

Trait Implementations

impl Clone for TCModelV2

fn clone(&self) -> TCModelV2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TCModelV2

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

Formats the value using the given formatter.

impl Default for TCModelV2

fn default() -> TCModelV2

Returns the "default value" for a type.

impl Hash for TCModelV2

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<TCModelV2> for TCModelV2

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

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

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

This method tests for !=.

impl PartialOrd<TCModelV2> for TCModelV2

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

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

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

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

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

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

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

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

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

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

impl StructuralPartialEq for TCModelV2

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

type Error = TcsError

The type returned in the event of a conversion error.

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

Performs the conversion.