Struct GitHubFormat

pub struct GitHubFormat {
    pub repo_id: String,
    pub owner: String,
    pub repo: String,
    pub headers: HashMap<String, String>,
    pub agent: Agent,
}

Stof GitHub Format.

Fields

repo_id: String

Format Repo ID. Ex. “formata” means format is “github:formata”.

owner: String

Repository owner.

repo: String

Repository name.

headers: HashMap<String, String>

Headers.

agent: Agent

Agent.

Implementations

impl GitHubFormat

pub fn new(repo: &str, owner: &str) -> Self

Create a new GitHub Format.

pub fn url(&self, path: &str) -> String

The URL for a request into this GitHub repository.

pub fn get(&self, file_path: &str) -> Result<String>

Get the string contents for a file path into this GitHub repository.

Trait Implementations

impl Format for GitHubFormat

fn format(&self) -> String

How this format will be accessed in Stof. For example, if repo_id is “formata”, using this library would be the format identifier “github:formata”.

import github:formata "myfile.stof" as Import;

fn file_import( &self, pid: &str, doc: &mut SDoc, _format: &str, full_path: &str, extension: &str, as_name: &str, ) -> Result<()>

The GitHub format only allows a file import. Gets the contents of the file at a path in this GitHub repo, then imports it as a string using the file extension. Will error if a Format with the requested file extension is not available in the doc.

fn content_type(&self) -> String

Content type. Used when sending documents over the wire, etc…

fn header_import( &self, pid: &str, doc: &mut SDoc, content_type: &str, bytes: &mut Bytes, as_name: &str, ) -> Result<(), Error>

Content type import.

fn string_import( &self, pid: &str, doc: &mut SDoc, src: &str, as_name: &str, ) -> Result<(), Error>

String import.

fn export_string( &self, pid: &str, doc: &SDoc, node: Option<&SNodeRef>, ) -> Result<String, Error>

Export document into a string (human readable string).

fn export_min_string( &self, pid: &str, doc: &SDoc, node: Option<&SNodeRef>, ) -> Result<String, Error>

Export document into a string (minified string).

fn export_bytes( &self, pid: &str, doc: &SDoc, node: Option<&SNodeRef>, ) -> Result<Bytes, Error>

Export document into bytes.