Expand description
Forge-independent reconciliation types shared by forge adapters.
Modules§
- access 🔒
- Team and collaborator access policy and the planning shared by every forge.
- backend 🔒
- The contract between the shared planner and a forge adapter.
- codec 🔒
- A planned [
Value] round-tripped through JSON into a concrete shape, which is how a forge adapter decodes a planned field back into the typed request or response body a write expects. - collection 🔒
- diff 🔒
- label 🔒
- Repository label policy shared by every forge.
- limitation 🔒
- mode 🔒
- name 🔒
- name_
set 🔒 - comparison and write.
- operation 🔒
- plan 🔒
- Planning and application independent of a forge transport.
- refusal 🔒
- release 🔒
- Release and pull request wire shapes both forges speak.
- repo 🔒
- The
<owner>/<name>pair the CLI operates on. - report 🔒
- segment 🔒
- state 🔒
- Evaluated repository-settings input consumed by the forge adapters.
- string_
enum 🔒 - transport 🔒
- HTTP transport shared by every forge adapter.
- variable_
name 🔒 - webhook 🔒
Macros§
- non_
empty_ name - Define a string newtype that is never empty.
- operation_
enum - Define the enum that wraps the operations of each resource.
- string_
enum - Define an enum whose variants have fixed wire names.
Structs§
- Access
- Repository team and collaborator access policy.
- Access
State - The team and collaborator grants a forge reports for one repository.
- Asset
Wire - A release asset as the forge returns it.
- Collection
- A keyed collection of forge items, such as labels or webhooks.
- Draft
Release - The body that creates a draft release.
- Empty
Team Name - A team name was the empty string.
- Empty
User Name - A user name was the empty string.
- Field
Change - One field that differs, with its live and desired values.
- Field
Diff - Fields compared on one resource, split into those that differ and those that already match.
- Field
Value - A field value kept in a form that renders on one line.
- Grants
- What the forge reports about team access to one repository.
- Http
- Shared HTTP transport for a forge’s REST API.
- Invalid
Label Color - A label color was not six hexadecimal digits.
- Label
- A label with the fields every forge has.
- Label
Color - A label color of six hexadecimal digits, stored in lowercase and without a leading hash.
- Labels
- Repository label policy.
- NameSet
- Names, sorted and deduplicated on construction.
- Object
Wire - A Git object wrapper, as returned for an annotated tag.
- Plan
- A pure reconciliation plan bound to one target repository.
- Planned
- The result of
Backend::plan. - Publish
Release - The body that publishes a draft release.
- Pull
Request Create - The body that opens a pull request.
- RefObject
- The object a Git ref points at.
- Release
Wire - A release as the forge returns it.
- Remote
State - A forge-tagged repository configuration.
- RepoRef
- A repository named on the command line.
- Repo
RefParse Error - A
RepoRefcould not be parsed from its<owner>/<name>form. - Report
- The plan result used by both text and machine reports.
- Request
Label - The method and path of a request, as it appears in an error.
- Retry
Policy - How a retryable failure is retried before it is reported.
- Shadowing
- Effective protection of the default branch.
- Team
Name - A team name, which is never empty.
- Transport
Build Error - Failure building the underlying HTTP client.
- Unknown
Value - A string that names none of the variants of an enum.
- User
Name - A user name, which is never empty and is compared in lowercase.
- Variable
Name Rules - The names a forge refuses for Actions variables, beyond the shared shape.
Enums§
- Access
Decision - One step toward the declared team access.
- Access
Operation - A write to team or collaborator grants that every forge has.
- Caller
- The account the tool runs as.
- Change
- What the plan does to one resource.
- Collaborator
Decision - One step toward the declared collaborator access.
- Forge
- Supported forges.
- Limitation
- A setting the forge exposes but the plan cannot change or manage.
- Lockout
- A grant that carries the caller’s own access and that a plan would remove.
- Mode
- How items that the configuration does not declare are treated.
- Observed
- A permission read from a forge, which may be one this tool cannot set.
- Permission
Scope - Where a forge stores a team’s permission.
- Plan
Error - A planning or application error.
- Refusal
- A reason a plan cannot be applied.
- Transport
Error - Anything that stops a request from producing a usable answer.
- Variable
Name Error - A set of Actions variable names that a forge cannot store.
- Webhook
Content Type - The body format of a webhook delivery.
Traits§
- Backend
- An adapter that reads one forge and applies planned writes to it.
Functions§
- encode
- Encode a request body that always encodes: a facet-derived struct of
plain fields or a [
Value] this crate built. - path_
segment - Percent-encode
valuefor use as one segment of a request path. - query_
value - Percent-encode
valuefor use as a query parameter value. - redecode
- Round-trip
valuethrough JSON intoT. - summarize
- Trim a forge error body so a huge HTML page cannot flood the output.