Struct MetaTagGroups 

#[non_exhaustive]
pub struct MetaTagGroups {
    pub apple: String,
    pub primary: String,
    pub og: String,
    pub ms: String,
    pub twitter: String,
}

Holds collections of meta tags for different platforms and categories.

Each field is the rendered <meta> elements of one group, one per line. MetaTagGroups::iter gives the same tags as values.

Example

use metadata_gen::metatags::generate_metatags;
use metadata_gen::MetadataMap;

let mut metadata = MetadataMap::new();
metadata.insert("description".to_string(), "A sample page".to_string());
metadata.insert("og:title".to_string(), "Sample".to_string());

let tags = generate_metatags(&metadata);
assert!(tags.primary.contains("description"));
assert!(tags.og.contains(r#"property="og:title""#));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

apple: String

Meta tags specific to Apple devices.

primary: String

Primary meta tags (description, keywords, author, viewport).

og: String

Open Graph meta tags.

ms: String

Microsoft-specific meta tags.

twitter: String

Twitter meta tags.

Implementations

impl MetaTagGroups

pub fn add_custom_tag(&mut self, name: &str, content: &str)

Adds a custom meta tag to the appropriate group, chosen by its name: apple-* and mobile-web-app-capable go to apple, msapplication-* to ms, Open Graph prefixes to og, twitter:* to twitter, everything else to primary.

Example

use metadata_gen::MetaTagGroups;

let mut groups = MetaTagGroups::default();
groups.add_custom_tag("og:locale", "en_GB");
assert_eq!(groups.og, r#"<meta property="og:locale" content="en_GB">"#);

pub fn format_meta_tag(&self, name: &str, content: &str) -> String

Formats one meta tag as MetaTag::render does.

Example

use metadata_gen::MetaTagGroups;

let groups = MetaTagGroups::default();
assert_eq!(
    groups.format_meta_tag("description", r#"say "hi""#),
    r#"<meta name="description" content="say &quot;hi&quot;">"#
);

pub fn generate_apple_meta_tags(&mut self, metadata: &MetadataMap)

Generates the Apple-specific group from metadata.

pub fn generate_primary_meta_tags(&mut self, metadata: &MetadataMap)

Generates the primary group (author, description, keywords, viewport) from metadata.

pub fn generate_og_meta_tags(&mut self, metadata: &MetadataMap)

Generates the Open Graph group from metadata.

pub fn generate_ms_meta_tags(&mut self, metadata: &MetadataMap)

Generates the Microsoft-specific group from metadata.

pub fn generate_twitter_meta_tags(&mut self, metadata: &MetadataMap)

Generates the Twitter group from metadata.

pub fn generate_tags(&self, metadata: &MetadataMap, tags: &[&str]) -> String

Renders every tag in tags that has a value in metadata, one per line, in the order given.

Example

use metadata_gen::{MetaTagGroups, MetadataMap};

let mut metadata = MetadataMap::new();
metadata.insert("author".into(), "Ada".into());
let groups = MetaTagGroups::default();
assert_eq!(
    groups.generate_tags(&metadata, &["author", "missing"]),
    r#"<meta name="author" content="Ada">"#
);

pub fn iter(&self) -> impl Iterator<Item = MetaTag> + '_

Every rendered element across the five groups, in group order, as MetaTag values again.

Example

use metadata_gen::MetaTagGroups;

let mut groups = MetaTagGroups::default();
groups.add_custom_tag("og:title", "T");
groups.add_custom_tag("author", "A");
let names: Vec<String> = groups.iter().map(|t| t.name).collect();
assert_eq!(names, ["author", "og:title"]);

Trait Implementations

impl Clone for MetaTagGroups

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetaTagGroups

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

Formats the value using the given formatter.

impl Default for MetaTagGroups

fn default() -> Self

Returns the “default value” for a type.

impl Display for MetaTagGroups

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

Formats the value using the given formatter.

impl Eq for MetaTagGroups

impl Hash for MetaTagGroups

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MetaTagGroups

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MetaTagGroups