| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Ecluse.Core.Registry.Adapter.Capability
Description
Registry capabilities used by the ecosystem-neutral pipeline. Adapters own wire formats and share exact source-entry selection for served metadata.
Synopsis
- data AdapterMetadata = AdapterMetadata {}
- data AdapterArtifact = AdapterArtifact {}
- data PrivateArtifactAddressing
- data AdapterPublish = AdapterPublish {
- publishCredential :: CredentialMapping
- publishRequestExtras :: RequestHeaders -> Either PublishBodyFault PublishExtras
- publishRelay :: ServicePresentation -> OriginClient -> PackageName -> PublishRequestBody -> IO (Either FetchFault PublishRelayResponse)
- publishUploadClaims :: Limits -> (Int -> IO ()) -> Text -> PublishRequestBody -> IO (Either PublishBodyFault [Text])
- publishCodec :: ServicePresentation -> PublishCodec
- publishMirrorRequirements :: MirrorRequirements
- publishUploadEndpoint :: UploadEndpointRequirement
- publishIdentity :: UploadIdentityRequirement
- data PublishRequestBody = PublishRequestBody {}
- data PublishExtras
- data MirrorRequirements = MirrorRequirements {}
- data WorkerMetadataRead
- data MirrorStateRequirement
- durableMirrorDocuments :: MirrorStateRequirement -> Maybe MirrorDocuments
- companionsAgree :: AdapterPublish -> Bool
- data UploadEndpointRequirement
- data UploadIdentityRequirement
- type ProjectName = Text -> Maybe PackageName
- data AdapterMaintenance = AdapterMaintenance {}
- data StoreListing = StoreListing {
- listingRequest :: OriginClient -> Either UrlFormationError Request
- listingWalk :: Cursor -> Step [PackageName]
- data VersionDelete = VersionDelete {}
Metadata
data AdapterMetadata Source #
The ecosystem's metadata read, served-document assembly, and encoding (pdMetadata).
Constructors
| AdapterMetadata | |
Fields
| |
Artifact requests
data AdapterArtifact Source #
Artifact request formation by filename or authoritative URL, shared by serve and worker (pdArtifact).
Constructors
| AdapterArtifact | |
Fields
| |
data PrivateArtifactAddressing Source #
Private artifact locations come from a conventional path or authoritative index metadata.
Constructors
| ConventionalArtifactPath | |
| IndexedArtifactLocation | |
| AdmittedIndexedArtifactLocation | Requires metadata admission before discovery or index workspace allocation. |
Instances
| Show PrivateArtifactAddressing Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods showsPrec :: Int -> PrivateArtifactAddressing -> ShowS # show :: PrivateArtifactAddressing -> String # showList :: [PrivateArtifactAddressing] -> ShowS # | |
| Eq PrivateArtifactAddressing Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods (==) :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool # (/=) :: PrivateArtifactAddressing -> PrivateArtifactAddressing -> Bool # | |
Publish
data AdapterPublish Source #
Native relay, identity validation, and mirror publication for one ecosystem.
Constructors
| AdapterPublish | |
Fields
| |
data PublishRequestBody Source #
Original request bytes and their declared media type, retained under byte admission.
Constructors
| PublishRequestBody | |
data PublishExtras Source #
Checked native publication headers. Secrets never enter durable mirror state.
Constructors
| NoPublishExtras | |
| PublishOneTimePassword Secret | A one-time password the caller presented for this publication. |
Instances
| Show PublishExtras Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods showsPrec :: Int -> PublishExtras -> ShowS # show :: PublishExtras -> String # showList :: [PublishExtras] -> ShowS # | |
| Eq PublishExtras Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods (==) :: PublishExtras -> PublishExtras -> Bool # (/=) :: PublishExtras -> PublishExtras -> Bool # | |
data MirrorRequirements Source #
Static mirror obligations, separate from runtime completion observations.
Constructors
| MirrorRequirements | |
Fields
| |
data WorkerMetadataRead Source #
Worker reads use cached facts, charged chunks, or native workspace reservations.
data MirrorStateRequirement Source #
Completion uses native inventory or requires durable version state.
Constructors
| NativeVersionState | |
| DurableVersionState MirrorDocuments | Completion and outage reads restore retained source documents through these operations. |
durableMirrorDocuments :: MirrorStateRequirement -> Maybe MirrorDocuments Source #
The durable format's document operations, absent where native inventory proves completion.
companionsAgree :: AdapterPublish -> Bool Source #
Whether the mirror codec prepares native companions exactly where the state format requires them.
data UploadEndpointRequirement Source #
Whether the protocol writes at its read root or at a separate endpoint.
Constructors
| ReadRootUpload | |
| ExplicitUploadEndpoint |
Instances
| Show UploadEndpointRequirement Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods showsPrec :: Int -> UploadEndpointRequirement -> ShowS # show :: UploadEndpointRequirement -> String # showList :: [UploadEndpointRequirement] -> ShowS # | |
| Eq UploadEndpointRequirement Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods (==) :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool # (/=) :: UploadEndpointRequirement -> UploadEndpointRequirement -> Bool # | |
data UploadIdentityRequirement Source #
Named protocols require a username when using a static token.
Constructors
| TokenIdentity | |
| NamedIdentity |
Instances
| Show UploadIdentityRequirement Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods showsPrec :: Int -> UploadIdentityRequirement -> ShowS # show :: UploadIdentityRequirement -> String # showList :: [UploadIdentityRequirement] -> ShowS # | |
| Eq UploadIdentityRequirement Source # | |
Defined in Ecluse.Core.Registry.Adapter.Capability Methods (==) :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool # (/=) :: UploadIdentityRequirement -> UploadIdentityRequirement -> Bool # | |
Names
type ProjectName = Text -> Maybe PackageName Source #
Canonicalise a raw name under one ecosystem's grammar: the one parser every caller reaches a PackageName through.
Store maintenance
data AdapterMaintenance Source #
Store maintenance verbs for Ecluse.Core.Registry.Maintenance.Protocol. A missing verb makes the Dredger refuse.
Constructors
| AdapterMaintenance | |
Fields
| |
data StoreListing Source #
The protocol's own listing of a store. A public registry may refuse it, and the caller reports a non-200.
Constructors
| StoreListing | |
Fields
| |
data VersionDelete Source #
One version's delete requests and their own document read, since an install-optimised read may omit the revision.
Constructors
| VersionDelete | |
Fields
| |