Documentation
¶
Overview ¶
Package flatfile decodes strict bounded versioned datasource documents into immutable in-memory snapshots.
On Linux and macOS the provider duplicates and owns a caller-opened directory descriptor, validates root and file metadata, and reads one no-follow file descriptor relative to that confined root. Reload publishes a complete generation atomically. A failed reload retains the prior snapshot only for recovery and makes later resolves unavailable until an explicit successful reload. The package never resolves paths from record values, exposes private keys, serves degraded state, or runs background reload work.
Index ¶
- type Provider
- func (p *Provider) Close(ctx context.Context) (resultErr error)
- func (p *Provider) Format(state fmt.State, _ rune)
- func (p *Provider) GoString() string
- func (p *Provider) MarshalJSON() ([]byte, error)
- func (p *Provider) Reload(ctx context.Context) (resultErr error)
- func (p *Provider) ResolvePolicy(ctx context.Context, request datasource.PolicyRequest) (datasource.ResolvedPolicy, error)
- func (p *Provider) ResolveProfile(ctx context.Context, request datasource.ProfileRequest) (datasource.ResolvedProfile, error)
- func (p *Provider) State() (datasource.ProviderState, error)
- func (p *Provider) String() string
- func (p *Provider) Usage() (datasource.Usage, error)
- type Snapshot
- func (s *Snapshot) Format(state fmt.State, _ rune)
- func (s *Snapshot) GoString() string
- func (s *Snapshot) InspectPolicy(ctx context.Context, request datasource.PolicyRequest) (datasource.ResolvedPolicy, error)
- func (s *Snapshot) MarshalJSON() ([]byte, error)
- func (s *Snapshot) ResolvePolicy(ctx context.Context, request datasource.PolicyRequest) (datasource.ResolvedPolicy, error)
- func (s *Snapshot) ResolveProfile(ctx context.Context, request datasource.ProfileRequest) (datasource.ResolvedProfile, error)
- func (s *Snapshot) String() string
- func (s *Snapshot) Usage() (datasource.Usage, error)
- func (s *Snapshot) Valid() bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider owns one confined root capability and atomically reloadable snapshot.
func (*Provider) MarshalJSON ¶
MarshalJSON emits an empty object so provider internals cannot be serialized.
func (*Provider) Reload ¶
Reload serializes one explicit load and atomically publishes success or degradation.
func (*Provider) ResolvePolicy ¶
func (p *Provider) ResolvePolicy( ctx context.Context, request datasource.PolicyRequest, ) (datasource.ResolvedPolicy, error)
ResolvePolicy resolves against the one lifecycle snapshot captured at linearization.
func (*Provider) ResolveProfile ¶
func (p *Provider) ResolveProfile( ctx context.Context, request datasource.ProfileRequest, ) (datasource.ResolvedProfile, error)
ResolveProfile resolves against the one lifecycle snapshot captured at linearization.
func (*Provider) State ¶
func (p *Provider) State() (datasource.ProviderState, error)
State returns the bounded lifecycle state without exposing generation or records.
type Snapshot ¶
type Snapshot struct {
// contains filtered or unexported fields
}
Snapshot owns one immutable decoded provider and its parser accounting.
func DecodeReader ¶
func DecodeReader( generation uint64, reader io.Reader, limits datasource.Limits, ) (snapshot *Snapshot, resultErr error)
DecodeReader reads at most one byte beyond the file cap before decoding.
func (*Snapshot) InspectPolicy ¶
func (s *Snapshot) InspectPolicy( ctx context.Context, request datasource.PolicyRequest, ) (datasource.ResolvedPolicy, error)
InspectPolicy delegates exact inert binding inspection after the same immutable-snapshot and parser-accounting checks as runtime resolution.
func (*Snapshot) MarshalJSON ¶
MarshalJSON emits an empty object so decoded facts cannot be serialized.
func (*Snapshot) ResolvePolicy ¶
func (s *Snapshot) ResolvePolicy( ctx context.Context, request datasource.PolicyRequest, ) (datasource.ResolvedPolicy, error)
ResolvePolicy delegates one exact lookup to the immutable decoded provider.
func (*Snapshot) ResolveProfile ¶
func (s *Snapshot) ResolveProfile( ctx context.Context, request datasource.ProfileRequest, ) (datasource.ResolvedProfile, error)
ResolveProfile delegates one exact lookup to the immutable decoded provider.