Struct UserAgentDatabase

pub struct UserAgentDatabase { /* private fields */ }

Reference implementation of a UserAgentProvider.

It stores the profiles and several indices in memory to quickly find a profile by User-Agent header value string, UserAgentKind, PlatformKind and DeviceKind. Where needed it makes use of market share data to select a random profile or subset.

See UserAgentProvider for more details.

Implementations

impl UserAgentDatabase

pub fn embedded() -> UserAgentDatabase

Load the profiles embedded with the rama-ua crate.

This function is only available if the embed-profiles feature is enabled.

pub fn disable_unknown_user_agent_data(self, disable: bool) -> UserAgentDatabase

Disabling this option (disable = true) means here that in case you try to use UserAgentDatabase::get with a UserAgent containing no match (not even a platform or device), that it the database will return None instead of returning a global-random (market-based) UserAgentProfile, which it would do by default.

pub fn set_disable_unknown_user_agent_data( &mut self, disable: bool, ) -> &mut UserAgentDatabase

See [disable_unknown_user_agent_data], this is the non-consuming version.

pub fn len(&self) -> usize

Get the number of profiles in the database.

pub fn is_empty(&self) -> bool

Check if the database is empty.

pub fn iter_ua_str(&self) -> impl Iterator<Item = &str>

Iterate over the User-Agent header value strings in the database.

pub fn iter_ua_kind(&self) -> impl Iterator<Item = &UserAgentKind>

Iterate over the available UserAgentKinds in the database.

pub fn iter_platform(&self) -> impl Iterator<Item = &PlatformKind>

Iterate over the available PlatformKinds in the database.

pub fn iter_device(&self) -> impl Iterator<Item = &DeviceKind>

Iterate over the available DeviceKinds in the database.

pub fn insert(&mut self, profile: UserAgentProfile)

Insert a new UserAgentProfile into the database, ensuring to also index it by User-Agent header value string, UserAgentKind, PlatformKind and DeviceKind.

pub fn rnd(&self) -> Option<&UserAgentProfile>

Select a random UserAgentProfile from the database.

It makes use of global market share data to select a random profile.

pub fn get_exact_header_str(&self, ua: &str) -> Option<&UserAgentProfile>

Get a UserAgentProfile from the database by an UserAgent header string

pub fn get(&self, ua: &UserAgent) -> Option<&UserAgentProfile>

Get a UserAgentProfile from the database by UserAgent.

It first tries to find the profile by User-Agent header value string, if not found it then makes use of UserAgentKind, PlatformKind and DeviceKind to find a profile.

pub fn iter(&self) -> impl Iterator<Item = &UserAgentProfile>

Iterate over all UserAgentProfiles in the database.

Trait Implementations

impl Debug for UserAgentDatabase

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

Formats the value using the given formatter.

impl Default for UserAgentDatabase

fn default() -> UserAgentDatabase

Returns the “default value” for a type.

impl FromIterator<UserAgentProfile> for UserAgentDatabase

fn from_iter<T>(iter: T) -> UserAgentDatabase

where T: IntoIterator<Item = UserAgentProfile>,

Creates a value from an iterator.

impl UserAgentProvider for UserAgentDatabase

fn select_user_agent_profile(&self, ctx: &Context) -> Option<&UserAgentProfile>

Selects a user agent profile based on the current context.