#[non_exhaustive]pub struct GitHubDocumentCrawlProperties {
pub crawl_repository_documents: bool,
pub crawl_issue: bool,
pub crawl_issue_comment: bool,
pub crawl_issue_comment_attachment: bool,
pub crawl_pull_request: bool,
pub crawl_pull_request_comment: bool,
pub crawl_pull_request_comment_attachment: bool,
}
Expand description
Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.crawl_repository_documents: bool
TRUE
to index all files with a repository.
crawl_issue: bool
TRUE
to index all issues within a repository.
crawl_issue_comment: bool
TRUE
to index all comments on issues.
crawl_issue_comment_attachment: bool
TRUE
to include all comment attachments for issues.
crawl_pull_request: bool
TRUE
to index all pull requests within a repository.
crawl_pull_request_comment: bool
TRUE
to index all comments on pull requests.
crawl_pull_request_comment_attachment: bool
TRUE
to include all comment attachments for pull requests.
Implementations§
Source§impl GitHubDocumentCrawlProperties
impl GitHubDocumentCrawlProperties
Sourcepub fn crawl_repository_documents(&self) -> bool
pub fn crawl_repository_documents(&self) -> bool
TRUE
to index all files with a repository.
Sourcepub fn crawl_issue(&self) -> bool
pub fn crawl_issue(&self) -> bool
TRUE
to index all issues within a repository.
Sourcepub fn crawl_issue_comment(&self) -> bool
pub fn crawl_issue_comment(&self) -> bool
TRUE
to index all comments on issues.
Sourcepub fn crawl_issue_comment_attachment(&self) -> bool
pub fn crawl_issue_comment_attachment(&self) -> bool
TRUE
to include all comment attachments for issues.
Sourcepub fn crawl_pull_request(&self) -> bool
pub fn crawl_pull_request(&self) -> bool
TRUE
to index all pull requests within a repository.
Sourcepub fn crawl_pull_request_comment(&self) -> bool
pub fn crawl_pull_request_comment(&self) -> bool
TRUE
to index all comments on pull requests.
Sourcepub fn crawl_pull_request_comment_attachment(&self) -> bool
pub fn crawl_pull_request_comment_attachment(&self) -> bool
TRUE
to include all comment attachments for pull requests.
Source§impl GitHubDocumentCrawlProperties
impl GitHubDocumentCrawlProperties
Sourcepub fn builder() -> GitHubDocumentCrawlPropertiesBuilder
pub fn builder() -> GitHubDocumentCrawlPropertiesBuilder
Creates a new builder-style object to manufacture GitHubDocumentCrawlProperties
.
Trait Implementations§
Source§impl Clone for GitHubDocumentCrawlProperties
impl Clone for GitHubDocumentCrawlProperties
Source§fn clone(&self) -> GitHubDocumentCrawlProperties
fn clone(&self) -> GitHubDocumentCrawlProperties
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for GitHubDocumentCrawlProperties
impl PartialEq for GitHubDocumentCrawlProperties
Source§fn eq(&self, other: &GitHubDocumentCrawlProperties) -> bool
fn eq(&self, other: &GitHubDocumentCrawlProperties) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GitHubDocumentCrawlProperties
Auto Trait Implementations§
impl Freeze for GitHubDocumentCrawlProperties
impl RefUnwindSafe for GitHubDocumentCrawlProperties
impl Send for GitHubDocumentCrawlProperties
impl Sync for GitHubDocumentCrawlProperties
impl Unpin for GitHubDocumentCrawlProperties
impl UnwindSafe for GitHubDocumentCrawlProperties
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);