Skip to main content

Attribution

Struct Attribution 

Source
pub struct Attribution {
    pub provider: String,
    pub provider_uri: Option<Url>,
}
Expand description

Information about data providers of this place.

Attribution provides credit and source information for place data, ensuring proper recognition of data contributors and compliance with data usage requirements.

This information should be displayed when showing place data to users, helping maintain transparency about data sources and provider relationships.

Fields§

§provider: String

Name of the place’s data provider.

The display name or organization name of the entity that provided this place data. This should be shown to users to give proper credit to data sources and maintain transparency about information origins.

§provider_uri: Option<Url>

URI to the place’s data provider.

Optional link to the data provider’s website, profile, or more information about the source. This can be used to create clickable attribution links that direct users to learn more about the data provider.

Implementations§

Source§

impl Attribution

Source

pub fn provider(&self) -> &String

Name of the place’s data provider.

The display name or organization name of the entity that provided this place data. This should be shown to users to give proper credit to data sources and maintain transparency about information origins.

Source

pub fn provider_uri(&self) -> &Option<Url>

URI to the place’s data provider.

Optional link to the data provider’s website, profile, or more information about the source. This can be used to create clickable attribution links that direct users to learn more about the data provider.

Source§

impl Attribution

Source

pub fn new(provider: impl Into<String>) -> Self

Creates a new Attribution with the specified provider name.

Used to construct attribution information with just the provider name. The provider URI can be added separately if available.

Source

pub fn with_uri( provider: impl Into<String>, provider_uri: &str, ) -> Result<Self, Error>

Creates a new Attribution with both provider name and URI.

Used when complete attribution information is available, including a link to the data provider’s website or profile page.

Returns whether this attribution has a clickable link.

Used to determine if the attribution should be displayed as a link or plain text, enabling appropriate UI rendering for attribution credits.

Source

pub fn is_valid(&self) -> bool

Returns whether this attribution has valid provider information.

Used to validate attribution data before displaying it to users, ensuring that meaningful attribution information is available.

Source

pub fn display_text(&self) -> String

Gets a display-friendly attribution text.

Provides formatted attribution text suitable for displaying in user interfaces, typically in the format “Data provided by [Provider]”.

Source

pub fn short_display_text(&self) -> String

Gets a short attribution text for compact displays.

Provides brief attribution text suitable for space-constrained interfaces like mobile apps, map overlays, or footer areas.

Source

pub fn to_html(&self) -> String

Generates HTML markup for the attribution.

Creates appropriate HTML markup with proper links if a provider URI is available, suitable for web applications and HTML-based displays.

Source

pub fn to_markdown(&self) -> String

Generates markdown markup for the attribution.

Creates markdown-formatted attribution text with links where appropriate, useful for documentation, README files, or markdown-based content.

Source

pub fn should_display_prominently(&self) -> bool

Returns whether this attribution should be prominently displayed.

Used to determine attribution display priority, with certain providers or data types requiring more prominent attribution display.

Source

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

Gets the domain from the provider URI if available.

Extracts the domain portion of the provider URI for display purposes or security checks, useful for showing compact attribution information.

Creates a user-friendly link description.

Generates descriptive text for links that provides context about where the link leads, useful for accessibility and user experience.

Trait Implementations§

Source§

impl Clone for Attribution

Source§

fn clone(&self) -> Attribution

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Attribution

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Attribution

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for Attribution

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Attribution

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Attribution

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Attribution

Source§

impl StructuralPartialEq for Attribution

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,