Struct repo_icons::ReadmeImage

source ·

pub struct ReadmeImage {
    pub src: Url,
    pub headers: HashMap<String, String>,
    pub in_primary_heading: bool,
    pub edge_of_primary_heading: bool,
    pub keyword_mentions: HashSet<KeywordMention>,
    pub sourced_from_repo: bool,
    pub links_to: Option<ProjectLink>,
    pub is_align_center: bool,
    pub has_size_attrs: bool,
}

Fields§

§src: Url§headers: HashMap<String, String>§in_primary_heading: bool

whether the image was in the primary markdown heading

§edge_of_primary_heading: bool

whether the image was the first/last one in the heading

§keyword_mentions: HashSet<KeywordMention>

whether the image mentions a keyword in its src / alt text

§sourced_from_repo: bool

whether the image src points to a file inside of the repo

§links_to: Option<ProjectLink>

whether the image has links to the projects

§is_align_center: bool

whether the image has the CSS “align: center”

§has_size_attrs: bool

whether the image has height or width attributes

Implementations§

source §

impl ReadmeImage

source

pub async fn get(
 readme: &Readme,
 elem_ref: &ElementRef<'_>,
 primary_heading: &mut PrimaryHeading<'_>
) -> Option<Self>

Examples found in repository ?

src/github_api/readme/mod.rs (line 117)

  pub async fn load_body(&self) -> Result<Vec<ReadmeImage>, Box<dyn Error>> {
    let body = gh_api_get!("repos/{}/{}/readme", self.owner, self.repo)
      .header("Accept", "application/vnd.github.html")
      .send()
      .await?
      .error_for_status()?
      .text()
      .await?;

    let document = Html::parse_document(&body);

    let primary_heading = &mut PrimaryHeading::new(&document);

    let mut images = Vec::new();
    for element_ref in document.select(selector!("img[src]")) {
      if let Some(image) = ReadmeImage::get(self, &element_ref, primary_heading).await {
        images.push(image);
      }
    }

    let mut iter = images.iter_mut().enumerate().peekable();
    while let Some((idx, image)) = iter.next() {
      if image.in_primary_heading
        && (idx == 0
          || iter
            .peek()
            .map(|(_, image)| !image.in_primary_heading)
            .unwrap_or(true))
      {
        image.edge_of_primary_heading = true;
      };
    }

    images.sort();

    warn!(
      "{:#?}",
      images
        .iter()
        .map(|img| (img.src.clone(), img.weight()))
        .collect::<Vec<_>>()
    );

    Ok(images)
  }

source

pub fn weight(&self) -> u8

Examples found in repository ?

src/github_api/readme/readme_image.rs (line 212)

211
212
213

  fn cmp(&self, other: &Self) -> Ordering {
    other.weight().cmp(&self.weight())
  }

More examples

Hide additional examples

src/github_api/readme/mod.rs (line 141)

  pub async fn load_body(&self) -> Result<Vec<ReadmeImage>, Box<dyn Error>> {
    let body = gh_api_get!("repos/{}/{}/readme", self.owner, self.repo)
      .header("Accept", "application/vnd.github.html")
      .send()
      .await?
      .error_for_status()?
      .text()
      .await?;

    let document = Html::parse_document(&body);

    let primary_heading = &mut PrimaryHeading::new(&document);

    let mut images = Vec::new();
    for element_ref in document.select(selector!("img[src]")) {
      if let Some(image) = ReadmeImage::get(self, &element_ref, primary_heading).await {
        images.push(image);
      }
    }

    let mut iter = images.iter_mut().enumerate().peekable();
    while let Some((idx, image)) = iter.next() {
      if image.in_primary_heading
        && (idx == 0
          || iter
            .peek()
            .map(|(_, image)| !image.in_primary_heading)
            .unwrap_or(true))
      {
        image.edge_of_primary_heading = true;
      };
    }

    images.sort();

    warn!(
      "{:#?}",
      images
        .iter()
        .map(|img| (img.src.clone(), img.weight()))
        .collect::<Vec<_>>()
    );

    Ok(images)
  }