Skip to main content

Module github

Module github 

Source
Expand description

GitHub Permalink expansion.

This module provides functionality for parsing GitHub permalink URLs and fetching raw file content to display as code blocks.

Structsยง

GitHubExpander
GitHub permalink expander.
GitHubPermalink
A parsed GitHub permalink.
HttpClient
TypeMap key for the shared reqwest HTTP client used to fetch raw content.
LimitedBody ๐Ÿ”’
Accumulates response chunks until enough lines are received or MAX_BODY_BYTES is exceeded.
LineRange
A line range extracted from a GitHub permalink fragment.

Enumsยง

GitHubExpandError
Errors that can occur when expanding a GitHub permalink.

Constantsยง

MAX_BODY_BYTES ๐Ÿ”’
Maximum number of body bytes read from a raw response.

Staticsยง

GITHUB_PERMALINK_REGEX ๐Ÿ”’
Regex pattern for matching GitHub blob URLs.

Functionsยง

is_commit_sha ๐Ÿ”’
Returns true if the given string looks like a commit SHA (4-40 hex characters).
read_body_limited ๐Ÿ”’
Reads the response body chunk by chunk, stopping as soon as needed_lines complete lines have been received.
shorten_ref ๐Ÿ”’
Shortens a git ref for display. Commit SHAs are truncated to 7 characters; branch/tag names are returned as-is.
truncate_lines ๐Ÿ”’
Truncates lines to the given maximum, returning the joined string and whether truncation occurred.