inuse

package

v0.2.0 Latest Latest Go to latest Published: Oct 22, 2026 License: AGPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getsphericon/sphericon

Links

Open Source Insights

Documentation ¶

Overview ¶

Package inuse is the one shape of a refused removal (ADR 0049): a row that live work still uses is not removed, and the refusal names the users. Each domain module returns an *Error from its delete; each API surface renders it as its contract's InUseProblem (409, `usedBy`).

Index ¶

type Error
- func As(err error) (*Error, bool)
- func (e *Error) Error() string
type Kind
type Subject
type User
- func Broadcasts(rows []*ent.Broadcast) []User
- func Enrollments(automationID int64, name string, count int) User

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Error ¶

type Error struct {
	// What is the removed row, for the message.
	What  Subject
	Users []User
}

Error is a removal refused because Users still use the row. Callers match it with As.

func As ¶

func As(err error) (*Error, bool)

As reports the refusal an error carries, if it is one.

func (*Error) Error ¶

func (e *Error) Error() string

type Kind ¶

type Kind string

Kind is what a user of a row is.

const (
	// Broadcast is a Broadcast that has not finished sending.
	Broadcast Kind = "broadcast"
	// Automation is an Automation: one whose steps use the row, or an active one.
	Automation Kind = "automation"
	// Segment is a Segment whose rule names the row.
	Segment Kind = "segment"
	// Enrollment stands for the Enrollments of an Automation: one User naming the
	// Automation, with their Count.
	Enrollment Kind = "enrollment"
)

The kinds of live user a removal can find; each has a value of the contract's UsedByKind.

type Subject ¶

type Subject string

Subject is the row a refused removal was for.

const (
	SubjectSegment       Subject = "segment"
	SubjectTag           Subject = "tag"
	SubjectIntegration   Subject = "integration"
	SubjectSendingDomain Subject = "sending domain"
	SubjectAutomation    Subject = "automation"
)

The rows a removal can be refused for; the text reads "<subject> is in use by ...".

type User ¶

type User struct {
	Kind Kind
	ID   int64
	Name string
	// Count is how many rows an Enrollment User stands for; every other kind is one row and
	// leaves it zero.
	Count int
}

User is one row that uses the row a removal was refused for.

func Broadcasts ¶

func Broadcasts(rows []*ent.Broadcast) []User

Broadcasts maps Broadcasts to their Users, in the order given.

func Enrollments ¶

func Enrollments(automationID int64, name string, count int) User

Enrollments is the User that stands for count Enrollments of the Automation.

Source Files ¶

View all Source files

inuse.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL