Skip to main content

GithubActionsDependency

Struct GithubActionsDependency 

pub struct GithubActionsDependency {
    pub name: PackageName,
    pub name_range: Range,
    pub version_req: Option<VersionReq>,
    pub version_range: Option<Range>,
    pub version_literal: Option<String>,
    pub pin: Option<PinStyle>,
    pub source: DependencySource,
    pub is_plain_scalar: bool,
}
Expand description

Parsed uses: dependency from a GitHub Actions workflow file, with position tracking.

name is owner/repo — truncated at the second / for a subdirectory action (github/codeql-action/init@v3 -> github/codeql-action) or a reusable-workflow call (owner/repo/.github/workflows/x.yml@ref -> owner/repo).

Fields§

§name: PackageName

owner/repo identity.

§name_range: Range

LSP range of the owner/repo text (truncated at the second /).

§version_req: Option<VersionReq>

Normalized version requirement: the tag text for a [PinStyle::Tag] or a [PinStyle::Sha] with a comment_tag, the raw SHA for a commentless [PinStyle::Sha], the branch name for [PinStyle::Branch] — None for a non-resolvable source.

§version_range: Option<Range>

LSP range of the ref text — for a [PinStyle::Sha] with a comment_tag, this extends through the comment token (<40hex> # v4.2.0). None for a non-resolvable source or a bare uses: owner/repo with no @ at all.

§version_literal: Option<String>

The raw literal text version_range spans, when it differs from version_req — populated only for the SHA-with-comment form, where version_req is the comment-derived tag but version_range spans the full <sha> # <tag> text.

§pin: Option<PinStyle>

How the ref is pinned; None for a non-resolvable source.

§source: DependencySource

Dependency source: DependencySource::Registry for any @ref form (tag, SHA, or branch — all resolvable against the GitHub tags API by name alone), DependencySource::Path for ./local, DependencySource::Url for docker://image:tag and a reusable-workflow call.

§is_plain_scalar: bool

Whether the whole uses: value was written as a plain (unquoted) YAML scalar, as opposed to single- or double-quoted (uses: "actions/checkout@v4").

For a quoted scalar, version_range spans text inside the quotes — writing {sha} # {tag} there would place a # inside the string rather than starting a YAML comment, producing a uses: value GitHub Actions rejects and that re-parses as [PinStyle::Branch] (issue #473, spec 031 FR-010). A SHA-pin code action must check this before writing any edit that assumes an unquoted YAML comment can follow the ref text — see crate::formatter::GithubActionsFormatter::sha_pin_replacement_for’s caller.

Trait Implementations§

§

impl Clone for GithubActionsDependency

§

fn clone(&self) -> GithubActionsDependency

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for GithubActionsDependency

§

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

Formats the value using the given formatter. Read more
§

impl Dependency for GithubActionsDependency

§

fn name(&self) -> &PackageName

Package name
§

fn name_range(&self) -> Range

LSP range of the dependency name
§

fn version_requirement(&self) -> Option<&VersionReq>

Version requirement string (e.g., “^1.0”, “>=2.0”)
§

fn version_range(&self) -> Option<Range>

LSP range of the version string
§

fn source(&self) -> DependencySource

Dependency source (registry, git, path)
§

fn version_literal(&self) -> Option<&str>

The raw manifest text spanned by version_range, when it differs from version_requirement. Read more
§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to concrete type
Source§

fn features(&self) -> &[String]

Feature flags (ecosystem-specific, empty if not supported)
Source§

fn features_range(&self) -> Option<Range>

LSP range of the features array (ecosystem-specific, None if not supported)
Source§

fn markers(&self) -> Option<&str>

Environment marker expression gating this dependency (e.g. PEP 508’s python_version >= '3.8'). Ecosystem-specific, None if not supported or not present on this dependency.
Source§

fn markers_range(&self) -> Option<Range>

LSP range of the environment marker expression (ecosystem-specific, None if not supported or not present).
§

impl Eq for GithubActionsDependency

§

impl PartialEq for GithubActionsDependency

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl StructuralPartialEq for GithubActionsDependency

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more