dirsyn

func (ACIv3Attribute) Eq ¶

func (r ACIv3Attribute) Eq() ACIv3TargetRuleItem

Eq initializes and returns a new ACIv3TargetRuleItem instance configured to express the evaluation of the receiver value as Equal-To a ACIv3TargetAttr ACIv3TargetKeyword context.

func (ACIv3Attribute) Index ¶

func (r ACIv3Attribute) Index(idx int) string

func (ACIv3Attribute) IsZero ¶

func (r ACIv3Attribute) IsZero() bool

func (ACIv3Attribute) Keyword ¶

func (r ACIv3Attribute) Keyword() ACIv3Keyword

Keyword performs no useful task, as the receiver instance has no concept of a keyword. This method exists solely to satisfy Go's interface signature requirements and will return nil if executed.

func (ACIv3Attribute) Kind ¶

func (r ACIv3Attribute) Kind() string

Kind performs no useful task, as the receiver instance has no concept of a keyword, which is the typical value source for Kind calls. This method exists solely to satisfy Go's interface signature requirements and will return a zero string if executed.

func (ACIv3Attribute) Len ¶

func (r ACIv3Attribute) Len() int

func (ACIv3Attribute) Ne ¶

func (r ACIv3Attribute) Ne() (t ACIv3TargetRuleItem)

Ne initializes and returns a new ACIv3TargetRuleItem instance configured to express the evaluation of the receiver value as Not-Equal-To a ACIv3TargetAttr ACIv3TargetKeyword context.

Negated equality ACIv3TargetRuleItem instances should be used with caution.

func (ACIv3Attribute) Push ¶

func (r ACIv3Attribute) Push(x ...any) ACIv3Attribute

Push appends zero (0) or more attributes to the receiver instance.

func (ACIv3Attribute) String ¶

func (r ACIv3Attribute) String() string

String returns the string representation of the receiver instance.

func (ACIv3Attribute) TRM ¶

func (r ACIv3Attribute) TRM() ACIv3TargetRuleMethods

TRM returns an instance of ACIv3TargetRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3TargetRuleItem instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3TargetRuleMethod instance for OPTIONAL use in the creation of a ACIv3TargetRuleItem instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3TargetRuleItem instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly initialized, populated and prepared for such activity.

func (ACIv3Attribute) Valid ¶

func (r ACIv3Attribute) Valid() (err error)

Valid returns an error following an analysis of the receiver instance.

func (ACIv3AttributeBindTypeOrValue) BRM ¶

func (r ACIv3AttributeBindTypeOrValue) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

func (ACIv3AttributeBindTypeOrValue) Eq ¶

func (r ACIv3AttributeBindTypeOrValue) Eq() (b ACIv3BindRule)

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To a ACIv3BindUAT or ACIv3BindGAT ACIv3BindKeyword context.

func (ACIv3AttributeBindTypeOrValue) IsZero ¶

func (r ACIv3AttributeBindTypeOrValue) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

func (ACIv3AttributeBindTypeOrValue) Keyword ¶

func (r ACIv3AttributeBindTypeOrValue) Keyword() ACIv3Keyword

Keyword returns the ACIv3BindKeyword associated with the receiver instance, enveloped as a ACIv3Keyword. In the context of this type instance, the ACIv3BindKeyword returned will always be one (1) of ACIv3BindUAT or ACIv3BindGAT.

func (ACIv3AttributeBindTypeOrValue) Ne ¶

func (r ACIv3AttributeBindTypeOrValue) Ne() (b ACIv3BindRule)

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To a ACIv3BindUAT or ACIv3BindGAT ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

func (ACIv3AttributeBindTypeOrValue) Set ¶

func (r ACIv3AttributeBindTypeOrValue) Set(x ...any) ACIv3AttributeBindTypeOrValue

Set assigns value(s) x to the receiver. The value(s) must be ACIv3Attribute and/or AttributeValue instances, created via the package-level [AT] and [AV] functions respectively.

func (ACIv3AttributeBindTypeOrValue) String ¶

func (r ACIv3AttributeBindTypeOrValue) String() string

String returns the string representation of the receiver instance.

func (ACIv3AttributeBindTypeOrValue) Valid ¶

func (r ACIv3AttributeBindTypeOrValue) Valid() (err error)

Valid returns an error indicative of whether the receiver is in an aberrant state.

func (ACIv3AttributeFilter) Attribute ¶

func (r ACIv3AttributeFilter) Attribute() ACIv3Attribute

AttributeType returns the underlying instance of ACIv3Attribute, or a bogus ACIv3Attribute if unset.

func (ACIv3AttributeFilter) Filter ¶

func (r ACIv3AttributeFilter) Filter() Filter

Filter returns the underlying instance of Filter, or a bogus Filter if unset.

func (ACIv3AttributeFilter) IsZero ¶

func (r ACIv3AttributeFilter) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

func (ACIv3AttributeFilter) Keyword ¶

func (r ACIv3AttributeFilter) Keyword() ACIv3Keyword

Keyword returns the ACIv3TargetKeyword associated with the receiver instance enveloped as a ACIv3Keyword. In the context of this type instance, the ACIv3TargetKeyword returned is always ACIv3TargetFilter.

func (*ACIv3AttributeFilter) Set ¶

func (r *ACIv3AttributeFilter) Set(x ...any) *ACIv3AttributeFilter

Set assigns the provided address component to the receiver and returns the receiver instance in fluent-form.

Multiple values can be provided in variadic form, or piecemeal.

func (ACIv3AttributeFilter) String ¶

func (r ACIv3AttributeFilter) String() string

String returns the string representation of the receiver instance.

func (ACIv3AttributeFilter) Valid ¶

func (r ACIv3AttributeFilter) Valid() (err error)

Valid returns an error indicative of whether the receiver is in an aberrant state.

func (ACIv3AttributeFilterOperation) Eq ¶

func (r ACIv3AttributeFilterOperation) Eq() ACIv3TargetRuleItem

Eq initializes and returns a new ACIv3TargetRule instance configured to express the evaluation of the receiver value as Equal-To a ACIv3TargetAttrFilters ACIv3TargetKeyword context.

func (ACIv3AttributeFilterOperation) IsZero ¶

func (r ACIv3AttributeFilterOperation) IsZero() bool

IsZero wraps the [stackage.Stack.IsZero] method.

func (ACIv3AttributeFilterOperation) Keyword ¶

func (r ACIv3AttributeFilterOperation) Keyword() ACIv3Keyword

Keyword returns the ACIv3TargetKeyword associated with the receiver instance. In the context of this type instance, the ACIv3TargetKeyword returned is always ACIv3TargetAttrFilters.

func (ACIv3AttributeFilterOperation) Kind ¶

func (r ACIv3AttributeFilterOperation) Kind() string

Kind returns the categorical label assigned to the receiver.

func (ACIv3AttributeFilterOperation) Len ¶

func (r ACIv3AttributeFilterOperation) Len() int

Len returns the integer length of the receiver instance. The maximum length for instances of this kind is two (2).

func (ACIv3AttributeFilterOperation) Ne ¶

func (r ACIv3AttributeFilterOperation) Ne() ACIv3TargetRuleItem

Ne performs no useful task, as negated equality comparison does not apply to ACIv3TargetRule instances that bear the ACIv3TargetAttrFilters ACIv3TargetKeyword context.

This method exists solely to convey this message and conform to Go's interface qualifying signature. When executed, this method will return a bogus ACIv3TargetRule.

Negated equality ACIv3TargetRule instances should be used with caution.

func (ACIv3AttributeFilterOperation) SetDelimiter ¶

func (r ACIv3AttributeFilterOperation) SetDelimiter(i ...int) ACIv3AttributeFilterOperation

SetDelimiter controls the delimitation scheme employed by the receiver. A value of one (1) overrides the default comma (",") delimiter with a semicolon (";").

func (ACIv3AttributeFilterOperation) String ¶

func (r ACIv3AttributeFilterOperation) String() string

String returns the string representation of the receiver instance.

func (ACIv3AttributeFilterOperation) TRM ¶

func (r ACIv3AttributeFilterOperation) TRM() ACIv3TargetRuleMethods

TRM returns an instance of ACIv3TargetRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3TargetRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3TargetRuleMethod instance for OPTIONAL use in the creation of a ACIv3TargetRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3TargetRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

func (ACIv3AttributeFilterOperation) Valid ¶

func (r ACIv3AttributeFilterOperation) Valid() error

Valid wraps the [stackage.Stack.Valid] method.

func (ACIv3AttributeFilterOperationItem) Contains ¶

func (r ACIv3AttributeFilterOperationItem) Contains(x any) bool

Contains returns a Boolean value indicative of whether the type and its value were located within the receiver.

Valid input types are ACIv3AttributeFilter or a valid string equivalent.

Case is significant in the matching process.

func (ACIv3AttributeFilterOperationItem) Eq ¶

func (r ACIv3AttributeFilterOperationItem) Eq() ACIv3TargetRuleItem

Eq initializes and returns a new [TargetRule] instance configured to express the evaluation of the receiver value as Equal-To a [TargetAttrFilters] [TargetKeyword] context.

func (ACIv3AttributeFilterOperationItem) Index ¶

func (r ACIv3AttributeFilterOperationItem) Index(idx int) ACIv3AttributeFilter

Index returns the Nth instance of ACIv3AttributeFilter present within the receiver instance.

func (ACIv3AttributeFilterOperationItem) IsZero ¶

func (r ACIv3AttributeFilterOperationItem) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3AttributeFilterOperationItem) Keyword ¶

func (r ACIv3AttributeFilterOperationItem) Keyword() ACIv3Keyword

Keyword returns the [TargetKeyword] associated with the receiver instance enveloped as a [Keyword]. In the context of this type instance, the [TargetAttrFilters] [TargetKeyword] context is always returned.

func (ACIv3AttributeFilterOperationItem) Kind ¶

func (r ACIv3AttributeFilterOperationItem) Kind() string

Kind returns the kind of receiver instance.

func (ACIv3AttributeFilterOperationItem) Len ¶

func (r ACIv3AttributeFilterOperationItem) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3AttributeFilterOperationItem) Ne ¶

func (r ACIv3AttributeFilterOperationItem) Ne() ACIv3TargetRuleItem

Ne performs no useful task, as negated equality comparison does not apply to ACIv3TargetRule instances that bear the ACIv3TargetAttrFilters ACIv3TargetKeyword context.

This method exists solely to convey this message and conform to Go's interface qualifying signature. When executed, this method will return a bogus ACIv3TargetRule.

Negated equality ACIv3TargetRule instances should be used with caution.

func (ACIv3AttributeFilterOperationItem) Operation ¶

func (r ACIv3AttributeFilterOperationItem) Operation() ACIv3AttributeOperation

Operation returns ACIv3AddOp, ACIv3DelOp or an invalid operation if unspecified.

func (ACIv3AttributeFilterOperationItem) Push ¶

func (r ACIv3AttributeFilterOperationItem) Push(x ...any) ACIv3AttributeFilterOperationItem

func (ACIv3AttributeFilterOperationItem) String ¶

func (r ACIv3AttributeFilterOperationItem) String() string

String returns the string representation of the receiver instance.

func (ACIv3AttributeFilterOperationItem) TRM ¶

func (r ACIv3AttributeFilterOperationItem) TRM() ACIv3TargetRuleMethods

TRM returns an instance of ACIv3TargetRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3TargetRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3TargetRuleMethod instance for OPTIONAL use in the creation of a ACIv3TargetRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3TargetRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

func (ACIv3AttributeFilterOperationItem) Valid ¶

func (r ACIv3AttributeFilterOperationItem) Valid() error

Valid returns an error following an analysis of the receiver instance.

func (ACIv3AttributeOperation) String ¶

func (r ACIv3AttributeOperation) String() string

String returns the string representation of the receiver instance.

func (ACIv3AuthenticationMethod) BRM ¶

func (r ACIv3AuthenticationMethod) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

meths := ACIv3Anonymous.BRM()
fmt.Printf("%d available aci.BindRuleMethod instances", meths.Len())

Output:

2 available aci.BindRuleMethod instances

func (ACIv3AuthenticationMethod) Eq ¶

func (r ACIv3AuthenticationMethod) Eq() ACIv3BindRule

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindAM ACIv3BindKeyword context.

fmt.Printf("%s", ACIv3SASL.Eq())

Output:

authmethod="SASL"

func (ACIv3AuthenticationMethod) Ne ¶

func (r ACIv3AuthenticationMethod) Ne() ACIv3BindRule

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindAM ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

fmt.Printf("%s", ACIv3Anonymous.Ne())

Output:

authmethod!="NONE"

func (ACIv3AuthenticationMethod) String ¶

func (r ACIv3AuthenticationMethod) String() (am string)

String returns the string representation of the receiver instance.

fmt.Printf("%s", ACIv3EXTERNAL)

Output:

SASL EXTERNAL

func (ACIv3AuthenticationMethod) Valid ¶

func (r ACIv3AuthenticationMethod) Valid() (err error)

func (ACIv3BindDistinguishedName) Contains ¶

func (r ACIv3BindDistinguishedName) Contains(x any) bool

Contains returns a Boolean value indicative of a match between x and a slice value in the receiver instance.

x MUST be a proper DistinguishedName instance, or its string equivalent.

func (ACIv3BindDistinguishedName) Eq ¶

func (r ACIv3BindDistinguishedName) Eq() ACIv3BindRule

Eq returns an instance of ACIv3BindRuleItem, enveloped as an ACIv3BindRule, bearing the associated ACIv3BindKeyword in equality form.

func (ACIv3BindDistinguishedName) Index ¶

func (r ACIv3BindDistinguishedName) Index(idx int) string

Index returns the Nth string present within the receiver instance.

func (ACIv3BindDistinguishedName) IsZero ¶

func (r ACIv3BindDistinguishedName) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3BindDistinguishedName) Len ¶

func (r ACIv3BindDistinguishedName) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3BindDistinguishedName) Ne ¶

func (r ACIv3BindDistinguishedName) Ne() ACIv3BindRule

Ne returns an instance of ACIv3BindRuleItem, enveloped as an ACIv3BindRule, bearing the associated ACIv3BindKeyword in negated equality form.

Negated equalient ACIv3BindRule instances should be used with caution.

func (ACIv3BindDistinguishedName) Push ¶

func (r ACIv3BindDistinguishedName) Push(x ...any) ACIv3BindDistinguishedName

Push appends zero (0) or more values to the receiver. Each value MUST be a DistinguishedName, or its string equivalent.

func (ACIv3BindKeyword) Kind ¶

func (r ACIv3BindKeyword) Kind() string

Kind returns the static string literal `bindRule` identifying the instance as a ACIv3BindKeyword.

fmt.Printf("%s", ACIv3BindUDN.Kind())

Output:

bindRule

func (ACIv3BindKeyword) String ¶

func (r ACIv3BindKeyword) String() (k string)

String returns the string representation of the receiver instance of ACIv3BindKeyword.

fmt.Printf("%s", ACIv3BindUDN)

Output:

userdn

func (ACIv3BindRuleAnd) Index ¶

func (r ACIv3BindRuleAnd) Index(idx int) ACIv3BindRule

Index returns the Nth underlying ACIv3BindRule slice index, if present.

func (ACIv3BindRuleAnd) IsParen ¶

func (r ACIv3BindRuleAnd) IsParen() (is bool)

IsParen returns a Boolean value indicative of the receiver instance being in a parenthetical state.

func (ACIv3BindRuleAnd) IsZero ¶

func (r ACIv3BindRuleAnd) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3BindRuleAnd) Kind ¶

func (r ACIv3BindRuleAnd) Kind() string

Kind returns the string literal "bindRuleAnd".

func (ACIv3BindRuleAnd) Len ¶

func (r ACIv3BindRuleAnd) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3BindRuleAnd) Push ¶

func (r ACIv3BindRuleAnd) Push(x ...any) ACIv3BindRule

Push appends the input instance(s) of ACIv3BindRule to the receiver instance.

func (ACIv3BindRuleAnd) SetPaddingStyle ¶

func (r ACIv3BindRuleAnd) SetPaddingStyle(style int) ACIv3BindRule

SetPaddingStyle controls whitespace padding during the string representation process.

A value of 0 disables padding, while any other positive value enables padding.

func (ACIv3BindRuleAnd) SetParen ¶

func (r ACIv3BindRuleAnd) SetParen(p bool) ACIv3BindRule

SetParen declares whether the receiver instance is parenthetical.

A value of true engages parenthetical encapsulation during the string representation process.

func (ACIv3BindRuleAnd) SetQuotationStyle ¶

func (r ACIv3BindRuleAnd) SetQuotationStyle(_ int) ACIv3BindRule

SetQuotationStyle performs no useful task, as the concept of setting a quotation style applies only to instances of *ACIv3BindRuleItem. This method exists solely to satisfy Go's interface signature requirements.

func (ACIv3BindRuleAnd) String ¶

func (r ACIv3BindRuleAnd) String() string

String returns the string representation of the receiver instance.

func (ACIv3BindRuleAnd) Valid ¶

func (r ACIv3BindRuleAnd) Valid() (err error)

Valid returns an error instance which, when non-nil, will indicate a flaw in an instance residing at a particular slice index.

func (ACIv3BindRuleItem) Expression ¶

func (r ACIv3BindRuleItem) Expression() any

Expression returns the underlying expression value currently set within the receiver instance.

func (ACIv3BindRuleItem) Index ¶

func (r ACIv3BindRuleItem) Index(_ int) ACIv3BindRule

Index returns the Nth underlying slice index, if present.

This type exports this method solely to satisfy Go's interface signature requirements and is not necessary to use upon instances of this type. If executed, this method returns the receiver instance.

func (ACIv3BindRuleItem) IsParen ¶

func (r ACIv3BindRuleItem) IsParen() (is bool)

IsParen returns a Boolean value indicative of the receiver instance being in a parenthetical state.

func (ACIv3BindRuleItem) IsZero ¶

func (r ACIv3BindRuleItem) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3BindRuleItem) Keyword ¶

func (r ACIv3BindRuleItem) Keyword() ACIv3BindKeyword

Keyword returns the ACIv3BindKeyword value currently set within the receiver instance.

func (ACIv3BindRuleItem) Kind ¶

func (r ACIv3BindRuleItem) Kind() string

Kind returns the string literal "bindRuleItem".

func (ACIv3BindRuleItem) Len ¶

func (r ACIv3BindRuleItem) Len() int

Len returns an integer length of one (1) if the instance has been initialized, and an integer length of zero (0) if not initialized.

This method exists solely to satisfy Go's interface signature requirements and is not necessary to use upon instances of this type.

func (ACIv3BindRuleItem) Operator ¶

func (r ACIv3BindRuleItem) Operator() ACIv3Operator

Operator returns the ACIv3Operator value currently set within the receiver instance.

func (ACIv3BindRuleItem) Push ¶

func (r ACIv3BindRuleItem) Push(_ ...any) ACIv3BindRule

Push performs no useful action, as this method exists solely to satisfy Go's interface signature requirements.

func (ACIv3BindRuleItem) SetExpression ¶

func (r ACIv3BindRuleItem) SetExpression(expr ...any) ACIv3BindRule

SetExpression assigns value expr to the receiver instance.

func (ACIv3BindRuleItem) SetKeyword ¶

func (r ACIv3BindRuleItem) SetKeyword(kw any) ACIv3BindRule

SetKeyword assigns ACIv3Keyword kw to the receiver instance.

func (ACIv3BindRuleItem) SetOperator ¶

func (r ACIv3BindRuleItem) SetOperator(op any) ACIv3BindRule

SetOperator assigns ACIv3Operator op to the receiver instance.

func (ACIv3BindRuleItem) SetPaddingStyle ¶

func (r ACIv3BindRuleItem) SetPaddingStyle(style int) ACIv3BindRule

SetPaddingStyle controls whitespace padding during the string representation process.

A value of 0 disables padding, while any other positive value enables padding.

func (ACIv3BindRuleItem) SetParen ¶

func (r ACIv3BindRuleItem) SetParen(p bool) ACIv3BindRule

SetParen declares whether the receiver instance is parenthetical.

A value of true engages parenthetical encapsulation during the string representation process.

func (ACIv3BindRuleItem) SetQuotationStyle ¶

func (r ACIv3BindRuleItem) SetQuotationStyle(style int) ACIv3BindRule

SetQuotationStyle allows the election of a particular multivalued quotation style offered by the various adopters of the ACIv3 syntax. In the context of a ACIv3BindRule, this will only have a meaningful impact if the keyword for the receiver is one (1) of the following:

• ACIv3BindUDN (userdn)
• ACIv3BindRDN (roledn)
• ACIv3BindGDN (groupdn)

Additionally, the underlying type set as the expression value within the receiver MUST be a [ACIv3BindDistinguishedNames] instance with two (2) or more distinguished names within.

See the const definitions for [MultivalOuterQuotes] (default) and [MultivalSliceQuotes] for details.

func (ACIv3BindRuleItem) String ¶

func (r ACIv3BindRuleItem) String() (s string)

String returns the string representation of the receiver instance.

func (ACIv3BindRuleItem) Valid ¶

func (r ACIv3BindRuleItem) Valid() (err error)

Valid returns an error instance which, when non-nil, will indicate a logical flaw, such a missing component of a ACIv3BindRuleItem qualifier, or some other issue.

func (ACIv3BindRuleMethods) Contains ¶

func (r ACIv3BindRuleMethods) Contains(cop any) bool

Contains returns a Boolean value indicative of whether the specified ACIv3Operator, which may be expressed as a string, int or native ACIv3Operator, is allowed for use by the type instance that created the receiver instance. This method offers a convenient alternative to the use of the Index method combined with an assertion value (such as ACIv3Eq, ACIv3Ne, "=", "Greater Than", et al).

In other words, if one uses the [FQDN]'s BRM method to create an instance of ACIv3BindRuleMethods, feeding Gt (Greater Than) to this method shall return false, as mathematical comparison does not apply to instances of the [FQDN] type.

func (ACIv3BindRuleMethods) Index ¶

func (r ACIv3BindRuleMethods) Index(idx any) (ACIv3Operator, ACIv3BindRuleMethod)

Index calls the input index (idx) within the internal structure of the receiver instance. If found, an instance of ACIv3Operator and its accompanying ACIv3BindRuleMethod instance are returned.

Valid input index types are integer (int), ACIv3Operator constant or string identifier. In the case of a string identifier, valid values are as follows:

• For ACIv3Eq (1): `=`, `ACIv3Eq`, `Equal To`
• For ACIv3Ne (2): `!=`, `ACIv3Ne`, `Not Equal To`
• For ACIv3Lt (3): `>`, `ACIv3Lt`, `Less Than`
• For ACIv3Le (4): `>=`, `ACIv3Le`, `Less Than Or Equal`
• For ACIv3Gt (5): `<`, `ACIv3Gt`, `Greater Than`
• For ACIv3Ge (6): `<=`, `ACIv3Ge`, `Greater Than Or Equal`

Case is not significant in the string matching process.

Please note that use of this method by way of integer or ACIv3Operator values utilizes fewer resources than a string lookup.

See the ACIv3Operator.Context, ACIv3Operator.String and ACIv3Operator.Description methods for accessing the above string values easily.

If the index was not matched, an invalid ACIv3Operator is returned alongside a nil ACIv3BindRuleMethod. This will also apply to situations in which the type instance which crafted the receiver is uninitialized, or is in an otherwise aberrant state.

func (ACIv3BindRuleMethods) IsZero ¶

func (r ACIv3BindRuleMethods) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

func (ACIv3BindRuleMethods) Len ¶

func (r ACIv3BindRuleMethods) Len() int

Len returns the integer length of the receiver. Note that the return value will NEVER be less than zero (0) nor greater than six (6).

func (ACIv3BindRuleMethods) Valid ¶

func (r ACIv3BindRuleMethods) Valid() (err error)

Valid returns the first encountered error returned as a result of execution of the first available ACIv3BindRuleMethod instance. This is useful in cases where a user wants to see if the desired instance(s) of ACIv3BindRuleMethod will produce a usable result.

func (ACIv3BindRuleNot) Index ¶

func (r ACIv3BindRuleNot) Index(idx int) ACIv3BindRule

Index returns the Nth underlying ACIv3BindRule slice index, if present.

Note that, in the case of instances of this type, this method is only meaningful if the underlying ACIv3BindRule qualifier type is an instance of ACIv3BindRuleAnd or ACIv3BindRuleOr.

func (ACIv3BindRuleNot) IsParen ¶

func (r ACIv3BindRuleNot) IsParen() (is bool)

IsParen returns a Boolean value indicative of the receiver instance being in a parenthetical state.

func (ACIv3BindRuleNot) IsZero ¶

func (r ACIv3BindRuleNot) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3BindRuleNot) Kind ¶

func (r ACIv3BindRuleNot) Kind() string

Kind returns the string literal "bindRuleNot".

func (ACIv3BindRuleNot) Len ¶

func (r ACIv3BindRuleNot) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3BindRuleNot) Push ¶

func (r ACIv3BindRuleNot) Push(x ...any) ACIv3BindRule

Push assigns the input instance of ACIv3BindRule to the receiver instance. Unlike other Push methods, this does not append.

func (ACIv3BindRuleNot) SetPaddingStyle ¶

func (r ACIv3BindRuleNot) SetPaddingStyle(style int) ACIv3BindRule

SetPaddingStyle controls whitespace padding during the string representation process.

A value of 0 disables padding, while any other positive value enables padding.

func (ACIv3BindRuleNot) SetParen ¶

func (r ACIv3BindRuleNot) SetParen(p bool) ACIv3BindRule

SetParen declares whether the receiver instance is parenthetical.

A value of true engages parenthetical encapsulation during the string representation process.

func (ACIv3BindRuleNot) SetQuotationStyle ¶

func (r ACIv3BindRuleNot) SetQuotationStyle(_ int) ACIv3BindRule

SetQuotationStyle performs no useful task, as the concept of setting a quotation style applies only to instances of *ACIv3BindRuleItem. This method exists solely to satisfy Go's interface signature requirements.

func (ACIv3BindRuleNot) String ¶

func (r ACIv3BindRuleNot) String() (s string)

String returns the string representation of the receiver instance.

func (ACIv3BindRuleNot) Valid ¶

func (r ACIv3BindRuleNot) Valid() (err error)

Valid returns an error instance which, when non-nil, will indicate a logical flaw, such as a nil or zero length ACIv3BindRule instance, a missing component of a ACIv3BindRuleItem qualifier, or some other issue.

func (ACIv3BindRuleOr) Index ¶

func (r ACIv3BindRuleOr) Index(idx int) ACIv3BindRule

Index returns the Nth underlying ACIv3BindRule slice index, if present.

func (ACIv3BindRuleOr) IsParen ¶

func (r ACIv3BindRuleOr) IsParen() (is bool)

IsParen returns a Boolean value indicative of the receiver instance being in a parenthetical state.

func (ACIv3BindRuleOr) IsZero ¶

func (r ACIv3BindRuleOr) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3BindRuleOr) Kind ¶

func (r ACIv3BindRuleOr) Kind() string

Kind returns the string literal "bindRuleOr".

func (ACIv3BindRuleOr) Len ¶

func (r ACIv3BindRuleOr) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3BindRuleOr) Push ¶

func (r ACIv3BindRuleOr) Push(x ...any) ACIv3BindRule

Push appends the input instance(s) of ACIv3BindRule to the receiver instance.

func (ACIv3BindRuleOr) SetPaddingStyle ¶

func (r ACIv3BindRuleOr) SetPaddingStyle(style int) ACIv3BindRule

SetPaddingStyle controls whitespace padding during the string representation process.

A value of 0 disables padding, while any other positive value enables padding.

func (ACIv3BindRuleOr) SetParen ¶

func (r ACIv3BindRuleOr) SetParen(p bool) ACIv3BindRule

SetParen declares whether the receiver instance is parenthetical.

A value of true engages parenthetical encapsulation during the string representation process.

func (ACIv3BindRuleOr) SetQuotationStyle ¶

func (r ACIv3BindRuleOr) SetQuotationStyle(_ int) ACIv3BindRule

SetQuotationStyle performs no useful task, as the concept of setting a quotation style applies only to instances of *ACIv3BindRuleItem. This method exists solely to satisfy Go's interface signature requirements.

func (ACIv3BindRuleOr) String ¶

func (r ACIv3BindRuleOr) String() string

String returns the string representation of the receiver instance.

func (ACIv3BindRuleOr) Valid ¶

func (r ACIv3BindRuleOr) Valid() (err error)

Valid returns an error instance which, when non-nil, will indicate a flaw in an instance residing at a particular slice index.

func (ACIv3BindType) String ¶

func (r ACIv3BindType) String() (b string)

String returns the string representation of the receiver instance of ACIv3BindType.

func (ACIv3Day) String ¶

func (r ACIv3Day) String() (day string)

String returns a single string name value for receiver instance of ACIv3Day.

func (ACIv3DayOfWeek) BRM ¶

func (r ACIv3DayOfWeek) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

func (ACIv3DayOfWeek) Eq ¶

func (r ACIv3DayOfWeek) Eq() (b ACIv3BindRule)

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindDoW ACIv3BindKeyword context.

func (ACIv3DayOfWeek) IsZero ¶

func (r ACIv3DayOfWeek) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

func (ACIv3DayOfWeek) Keyword ¶

func (r ACIv3DayOfWeek) Keyword() ACIv3Keyword

Keyword returns the ACIv3BindToD [BindKeyword].

func (ACIv3DayOfWeek) Len ¶

func (r ACIv3DayOfWeek) Len() int

Len returns the abstract integer length of the receiver, quantifying the number of ACIv3Day instances currently being expressed.

For example, if the receiver instance has its ACIv3Monday and ACIv3Friday ACIv3Day bits enabled, this would represent an abstract length of two (2).

func (ACIv3DayOfWeek) Ne ¶

func (r ACIv3DayOfWeek) Ne() (b ACIv3BindRule)

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindDoW ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

func (ACIv3DayOfWeek) Positive ¶

func (r ACIv3DayOfWeek) Positive(x ACIv3Day) (posi bool)

Positive wraps the shifty.BitValue.Positive method.

func (ACIv3DayOfWeek) Shift ¶

func (r ACIv3DayOfWeek) Shift(x ...any) ACIv3DayOfWeek

Shift wraps shifty.BitValue.Shift method to allow for bit-shifting of the receiver (r) instance using various representations of any number of days (string, int or ACIv3Day).

func (ACIv3DayOfWeek) String ¶

func (r ACIv3DayOfWeek) String() (s string)

String returns the string representation of the receiver instance. At least one ACIv3Day should register as positive in order for a valid string return to ensue.

func (ACIv3DayOfWeek) Unshift ¶

func (r ACIv3DayOfWeek) Unshift(x ...any) ACIv3DayOfWeek

Unshift wraps shifty.BitValue.Unshift method to allow for bit-unshifting of the receiver (r) instance using various representations of any number of days (string, int or ACIv3Day).

func (ACIv3DayOfWeek) Valid ¶

func (r ACIv3DayOfWeek) Valid() (err error)

Valid returns a Boolean value indicative of whether the receiver contains one or more valid bits representing known ACIv3Day values.

At least one ACIv3Day must be positive within the receiver.

func (ACIv3FQDN) BRM ¶

func (r ACIv3FQDN) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

var r NetscapeACIv3
f, err := r.FQDN("www.example.com")
if err != nil {
	fmt.Println(err)
	return
}
cops := f.BRM()
fmt.Printf("%T allows Eq: %t", f, cops.Contains(`=`))

Output:

dirsyn.ACIv3FQDN allows Eq: true

func (ACIv3FQDN) Eq ¶

func (r ACIv3FQDN) Eq() ACIv3BindRule

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindDNS ACIv3BindKeyword context.

var r NetscapeACIv3

f, _ := r.FQDN() // no need to check error w/o arguments.

// Let's set the host labels incrementally ...
f.Set(`www`)
f.Set(`example`)
f.Set(`com`)

fmt.Printf("%s", f.Eq())

Output:

dns="www.example.com"

var r NetscapeACIv3
f, err := r.FQDN("www.example.com")
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%s", f.Eq())

Output:

dns="www.example.com"

func (ACIv3FQDN) IsZero ¶

func (r ACIv3FQDN) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

var r NetscapeACIv3
f, err := r.FQDN("www.example.com")
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%t", f.IsZero())

Output:

false

func (ACIv3FQDN) Keyword ¶

func (r ACIv3FQDN) Keyword() ACIv3Keyword

Keyword returns the ACIv3BindKeyword instance assigned to the receiver instance as a ACIv3Keyword. This shall be the ACIv3BindKeyword that appears in a ACIv3BindRule containing the receiver instance as the expression value.

var f ACIv3FQDN
fmt.Printf("%v", f.Keyword())

Output:

dns

func (ACIv3FQDN) Len ¶

func (r ACIv3FQDN) Len() int

Len returns the abstract integer length of the receiver. The value returned represents the number of valid DNS labels within a given instance of ACIv3FQDN. For example, `www.example.com` has three (3) such labels.

var r NetscapeACIv3
f, err := r.FQDN("www.example.com")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%T contains %d DNS labels", f, f.Len())

Output:

dirsyn.ACIv3FQDN contains 3 DNS labels

func (ACIv3FQDN) Ne ¶

func (r ACIv3FQDN) Ne() ACIv3BindRule

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindDNS ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

var r NetscapeACIv3

f, err := r.FQDN(`www.example.com`)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", f.Ne().SetPaddingStyle(1))

Output:

dns != "www.example.com"

func (*ACIv3FQDN) Set ¶

func (r *ACIv3FQDN) Set(x ...any) *ACIv3FQDN

Set appends one or more domain labels to the receiver. The total character length of a single label CANNOT exceed sixty-three (63) characters. When added up, all domain label instances present within the receiver SHALL NOT collectively exceed two hundred fifty-three (253) characters.

Valid characters within labels:

• a-z
• A-Z
• 0-9
• Hyphen ('-', limited to [1:length-1] slice range)
• Asterisk ('*', use with care for wildcard DNS-based ACI ACIv3BindRule expressions)
• Full Stop ('.', see below for remarks on this character)

Users need not enter full stops (.) manually, given this method supports the use of variadic expressions, i.e.:

Set(`www`,`example`,`com`)

However, should full stops (.) be used within input values:

Set(`www.example.com`)

... the parser shall split the input into label components and add them to the receiver piecemeal in the intended order.

Please note that it is not necessary to include a NULL terminating full stop character (.) at the end (TLD?) of the intended ACIv3FQDN.

var r NetscapeACIv3
f, err := r.FQDN("*.example.com")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", f)

Output:

*.example.com

func (ACIv3FQDN) String ¶

func (r ACIv3FQDN) String() string

String returns the string representation of a fully-qualified domain name.

var r NetscapeACIv3
f, err := r.FQDN("example.com")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", f)

Output:

example.com

func (ACIv3FQDN) Valid ¶

func (r ACIv3FQDN) Valid() (err error)

Valid returns a Boolean value indicative of whether the receiver contents represent a legal fully-qualified domain name value.

var f ACIv3FQDN
fmt.Printf("Valid: %t", f.Valid() == nil)

Output:

Valid: false

func (ACIv3IPAddress) BRM ¶

func (r ACIv3IPAddress) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

var r NetscapeACIv3
ip, err := r.IPAddress("www.example.com")
if err != nil {
	fmt.Println(err)
	return
}
cops := ip.BRM()
fmt.Printf("%T allows Eq: %t", ip, cops.Contains(`=`))

Output:

dirsyn.ACIv3IPAddress allows Eq: true

func (ACIv3IPAddress) Eq ¶

func (r ACIv3IPAddress) Eq() ACIv3BindRule

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindIP ACIv3BindKeyword context.

var r NetscapeACIv3

i, err := r.IPAddress("192.8.", "10.7.0")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", i.Eq())

Output:

ip="192.8.,10.7.0"

var r NetscapeACIv3

i, _ := r.IPAddress()
fmt.Printf("%s", i.Set(`192.168.0`, `12.3.45.*`, `10.0.0.0/8`).Eq())

Output:

ip="192.168.0,12.3.45.*,10.0.0.0/8"

func (ACIv3IPAddress) IsZero ¶

func (r ACIv3IPAddress) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is considered nil, or unset.

var r NetscapeACIv3
ip, err := r.IPAddress(`10.8.`, `192.`)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%t", ip.IsZero())

Output:

false

func (ACIv3IPAddress) Keyword ¶

func (r ACIv3IPAddress) Keyword() ACIv3Keyword

Keyword returns the ACIv3BindKeyword assigned to the receiver instance. This shall be the keyword that appears in a ACIv3BindRule containing the receiver instance as the expression value.

var ip ACIv3IPAddress
fmt.Printf("%v", ip.Keyword())

Output:

ip

func (ACIv3IPAddress) Kind ¶

func (r ACIv3IPAddress) Kind() string

Kind returns the string representation of the receiver's kind.

var ip ACIv3IPAddress
fmt.Printf("%v", ip.Kind())

Output:

ip

func (ACIv3IPAddress) Len ¶

func (r ACIv3IPAddress) Len() int

Len returns the integer length of the receiver instance.

var r NetscapeACIv3
ip, err := r.IPAddress(`10.8.`)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%d", ip.Len())

Output:

1

func (ACIv3IPAddress) Ne ¶

func (r ACIv3IPAddress) Ne() ACIv3BindRule

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindIP ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

var r NetscapeACIv3

i, err := r.IPAddress("10.8.")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", i.Ne())

Output:

ip!="10.8."

func (*ACIv3IPAddress) Set ¶

func (r *ACIv3IPAddress) Set(addr ...string) *ACIv3IPAddress

Set assigns the provided address component to the receiver and returns the receiver instance in fluent-form.

Multiple values can be provided in variadic form, or piecemeal.

var r NetscapeACIv3

i, _ := r.IPAddress() // no need to check error w/o arguments.

i.Set(`192.168.0`).Set(`12.3.45.*`).Set(`10.0.0.0/8`)
neg := i.Ne().SetParen(true).SetPaddingStyle(1)
fmt.Printf("%s", neg)

Output:

( ip != "192.168.0,12.3.45.*,10.0.0.0/8" )

func (ACIv3IPAddress) String ¶

func (r ACIv3IPAddress) String() string

String returns the string representation of an IP address.

var r NetscapeACIv3
ip, err := r.IPAddress(`192.168.56.7`)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%s", ip)

Output:

192.168.56.7

func (ACIv3IPAddress) Valid ¶

func (r ACIv3IPAddress) Valid() error

Valid returns an error indicative of whether the receiver is in an aberrant state.

var ip ACIv3IPAddress
fmt.Printf("Valid: %t", ip.Valid() == nil)

Output:

Valid: false

func (ACIv3Inheritance) BRM ¶

func (r ACIv3Inheritance) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

abtv, err := r.AttributeBindTypeOrValue("userattr", attr, "uid=frank,ou=People,dc=example,dc=com")
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
inh, err = r.Inheritance(abtv, 1, 3)
if err != nil {
	fmt.Println(err)
	return
}

brm := inh.BRM()
fmt.Printf("%d available comparison operator methods", brm.Len())

Output:

2 available comparison operator methods

func (ACIv3Inheritance) Eq ¶

func (r ACIv3Inheritance) Eq() (b ACIv3BindRule)

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindUAT or ACIv3BindGAT ACIv3BindKeyword contexts.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue("userattr", attr, `uid=frank,ou=People,dc=example,dc=com`)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", inh.Eq())

Output:

userattr="parent[6,7].manager#uid=frank,ou=People,dc=example,dc=com"

func (ACIv3Inheritance) IsZero ¶

func (r ACIv3Inheritance) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver instance is nil, or unset.

var inh ACIv3Inheritance
fmt.Printf("%t", inh.IsZero())

Output:

true

func (ACIv3Inheritance) Keyword ¶

func (r ACIv3Inheritance) Keyword() (kw ACIv3Keyword)

Keyword returns the ACIv3BindKeyword associated with the receiver instance enveloped as a ACIv3Keyword. In the context of this type instance, the ACIv3BindKeyword returned will be either ACIv3BindUAT or ACIv3BindGAT.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue("userattr", attr, ACIv3BindTypeUSERDN)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Keyword: %s", inh.Keyword())

Output:

Keyword: userattr

func (ACIv3Inheritance) Len ¶

func (r ACIv3Inheritance) Len() int

Len returns the abstract integer length of the receiver, quantifying the number of ACIv3InheritanceLevel instances currently being expressed.

For example, if the receiver instance has its ACIv3Level1 and ACIv3Level5 bits enabled, this would represent an abstract length of two (2).

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue("userattr", attr, ACIv3BindTypeUSERDN)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Number of levels: %d", inh.Len())

Output:

Number of levels: 2

func (ACIv3Inheritance) Ne ¶

func (r ACIv3Inheritance) Ne() (b ACIv3BindRule)

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindUAT or ACIv3BindGAT ACIv3BindKeyword contexts.

Negated equality ACIv3BindRule instances should be used with caution.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue(ACIv3BindUAT, attr, `uid=frank,ou=People,dc=example,dc=com`)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level1, ACIv3Level3); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", inh.Ne())

Output:

userattr!="parent[1,3].manager#uid=frank,ou=People,dc=example,dc=com"

func (ACIv3Inheritance) Positive ¶

func (r ACIv3Inheritance) Positive(x any) (posi bool)

Positive wraps the shifty.BitValue.Positive method.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue(ACIv3BindUAT, attr, ACIv3BindTypeUSERDN)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Level 5 positive? %t", inh.Positive(5))

Output:

Level 5 positive? false

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var gat ACIv3AttributeBindTypeOrValue
gat, err = r.AttributeBindTypeOrValue("userattr", attr, ACIv3BindTypeGROUPDN)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(gat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Level 6 positive? %t", inh.Positive(`6`))

Output:

Level 6 positive? true

func (ACIv3Inheritance) Shift ¶

func (r ACIv3Inheritance) Shift(x ...any) ACIv3Inheritance

Shift wraps the shifty.BitValue.Shift method.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

value := `uid=frank,ou=People,dc=example,dc=com`

var abtv ACIv3AttributeBindTypeOrValue
abtv, err = r.AttributeBindTypeOrValue("groupattr", attr, value)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(abtv, 1, 3); err != nil {
	fmt.Println(err)
	return
}

inh.Unshift(1)           // we changed our mind; remove level "1"
inh.Unshift(`1`)         // (or, alternatively ...)
inh.Unshift(ACIv3Level1) // (or, alternatively ...)
inh.Shift(8)             // add the one we forgot

fmt.Printf("Number of levels: %d", inh.Len())

Output:

Number of levels: 2

func (ACIv3Inheritance) String ¶

func (r ACIv3Inheritance) String() (s string)

String returns the string name value for receiver instance.

The return value(s) are enclosed within square-brackets, followed by comma delimitation and are prefixed with "parent" before being returned.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

var uat ACIv3AttributeBindTypeOrValue
uat, err = r.AttributeBindTypeOrValue("userattr", attr, `uid=frank,ou=People,dc=example,dc=com`)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(uat, ACIv3Level6, ACIv3Level7); err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", inh)

Output:

parent[6,7].manager#uid=frank,ou=People,dc=example,dc=com

func (ACIv3Inheritance) Unshift ¶

func (r ACIv3Inheritance) Unshift(x ...any) ACIv3Inheritance

Unshift wraps the shifty.BitValue.Unshift method.

var r NetscapeACIv3

attr, err := r.Attribute(`manager`)
if err != nil {
	fmt.Println(err)
	return
}

value := `uid=frank,ou=People,dc=example,dc=com`

var abtv ACIv3AttributeBindTypeOrValue
abtv, err = r.AttributeBindTypeOrValue("groupattr", attr, value)
if err != nil {
	fmt.Println(err)
	return
}

var inh ACIv3Inheritance
if inh, err = r.Inheritance(abtv, 1, 3, 8); err != nil {
	fmt.Println(err)
	return
}

inh.Unshift(1)           // we changed our mind; remove level "1"
inh.Unshift(`1`)         // (or, alternatively ...)
inh.Unshift(ACIv3Level1) // (or, alternatively ...)

fmt.Printf("Number of levels: %d", inh.Len())

Output:

Number of levels: 2

func (ACIv3Inheritance) Valid ¶

func (r ACIv3Inheritance) Valid() (err error)

Valid returns an error indicative of whether the receiver is in an aberrant state.

var inh ACIv3Inheritance
fmt.Printf("%T.Valid: %t", inh, inh.Valid() == nil)

Output:

dirsyn.ACIv3Inheritance.Valid: false

func (ACIv3InheritanceLevel) String ¶

func (r ACIv3InheritanceLevel) String() (lvl string)

String returns a single string name value for receiver instance of [ACIv3Level].

fmt.Printf("%s", ACIv3Level8)

Output:

8

func (ACIv3Instruction) OID ¶

func (r ACIv3Instruction) OID() string

OID returns the official Netscape ACIv3 object identifier string literal "2.16.840.1.113730.3.1.55".

func (ACIv3Instruction) String ¶

func (r ACIv3Instruction) String() string

String returns the string representation of the receiver instance.

func (ACIv3ObjectIdentifier) Contains ¶

func (r ACIv3ObjectIdentifier) Contains(x any) bool

Contains returns a Boolean value indicative of whether value x, if a string or NumericOID instance, already resides within the receiver instance.

Case is not significant in the matching process.

func (ACIv3ObjectIdentifier) Eq ¶

func (r ACIv3ObjectIdentifier) Eq() ACIv3TargetRuleItem

Eq returns an instance of ACIv3TargetRuleItem which represents a keyword-based equality rule containing one (1) or more NumericOID instances.

var r NetscapeACIv3

oid, err := r.LDAPControlOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
	`1.3.6.1.4.1.56521.999.7`,
)

if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Target rule: %s", oid.Eq())

Output:

Target rule: (targetcontrol="1.3.6.1.4.1.56521.999.5||1.3.6.1.4.1.56521.999.6||1.3.6.1.4.1.56521.999.7")

func (ACIv3ObjectIdentifier) Index ¶

func (r ACIv3ObjectIdentifier) Index(idx int) NumericOID

Index returns the Nth instance of NumericOID present within the receiver instance.

var r NetscapeACIv3

oid, err := r.LDAPControlOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
	`1.3.6.1.4.1.56521.999.7`,
)

if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Slice keyword: %s", oid.Index(1))

Output:

Slice keyword: 1.3.6.1.4.1.56521.999.6

func (ACIv3ObjectIdentifier) IsZero ¶

func (r ACIv3ObjectIdentifier) IsZero() bool

IsZero wraps the [stackage.Stack.IsZero] method.

var oid ACIv3ObjectIdentifier
fmt.Printf("%T is zero: %t\n", oid, oid.IsZero())

Output:

dirsyn.ACIv3ObjectIdentifier is zero: true

func (ACIv3ObjectIdentifier) Keyword ¶

func (r ACIv3ObjectIdentifier) Keyword() ACIv3TargetKeyword

Keyword returns the ACIv3TargetKeyword associated with the receiver instance enveloped as a ACIv3TargetKeyword. In the context of this type instance, the ACIv3TargetKeyword returned is always ACIv3TargetExtOp or ACIv3TargetCtrl.

var r NetscapeACIv3

oid, err := r.LDAPExtendedOperationOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
	`1.3.6.1.4.1.56521.999.7`,
)

if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", oid.Keyword())

Output:

extop

func (ACIv3ObjectIdentifier) Len ¶

func (r ACIv3ObjectIdentifier) Len() int

Len wraps the [stackage.Stack.Len] method.

var r NetscapeACIv3

oid, err := r.LDAPExtendedOperationOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
	`1.3.6.1.4.1.56521.999.7`,
)

if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%d", oid.Len())

Output:

3

func (ACIv3ObjectIdentifier) Ne ¶

func (r ACIv3ObjectIdentifier) Ne() ACIv3TargetRuleItem

Ne returns an instance of ACIv3TargetRuleItem which represents a keyword-based negated equality rule containing one (1) or more NumericOID instances.

Negated equality ACIv3TargetRuleItem instances should be used with caution.

var r NetscapeACIv3

oid, err := r.LDAPExtendedOperationOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
	`1.3.6.1.4.1.56521.999.7`,
)

if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Target rule: %s", oid.Ne())

Output:

Target rule: (extop!="1.3.6.1.4.1.56521.999.5||1.3.6.1.4.1.56521.999.6||1.3.6.1.4.1.56521.999.7")

func (ACIv3ObjectIdentifier) Push ¶

func (r ACIv3ObjectIdentifier) Push(x ...any) ACIv3ObjectIdentifier

Push appends one (1) or more unique numeric OID values -- as string or NumericOID instances -- to the receiver instance.

var r NetscapeACIv3

oid, err := r.LDAPExtendedOperationOIDs(
	`1.3.6.1.4.1.56521.999.5`,
	`1.3.6.1.4.1.56521.999.6`,
)

if err != nil {
	fmt.Println(err)
	return
}

// Add a third OID we forgot:
oid.Push(`1.3.6.1.4.1.56521.999.7`)

fmt.Printf("%d", oid.Len())

Output:

3

func (ACIv3ObjectIdentifier) TRM ¶

func (r ACIv3ObjectIdentifier) TRM() ACIv3TargetRuleMethods

TRM returns an instance of ACIv3TargetRuleMethods.

Each of the return instance's key values represent a single ACIv3Operator that is allowed for use in the creation of ACIv3TargetRuleItem instances which bear the receiver instance as an expression value. The value for each key is the actual instance method to -- optionally -- use for the creation of the ACIv3TargetRuleItem.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3TargetRuleItem instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

var oid ACIv3ObjectIdentifier
fmt.Printf("Allows greater-than: %t", oid.TRM().Contains(ACIv3Gt))

Output:

Allows greater-than: false

func (ACIv3ObjectIdentifier) Valid ¶

func (r ACIv3ObjectIdentifier) Valid() error

Valid returns a Boolean value indicative of a valid receiver instance.

var oid ACIv3ObjectIdentifier
fmt.Printf("Valid: %t", oid.Valid() == nil)

Output:

Valid: false

func (ACIv3Operator) Compare ¶

func (r ACIv3Operator) Compare(cop any) bool

Compare shall resolve the input ACIv3Operator candidate (cop) and, if successful, shall perform an equality assertion between it and the receiver instance. The assertion result is returned as a bool instance.

In the case of the string representation of a given candidate input value, case-folding is not a significant factor.

func (ACIv3Operator) Context ¶

func (r ACIv3Operator) Context() (ctx string)

Context returns the contextual string name of the receiver instance:

• "Eq"
• "Ne"
• "Lt"
• "Gt"
• "Le"
• "Ge"

for _, cop := range []ACIv3Operator{
	ACIv3Eq, ACIv3Ne, ACIv3Lt, ACIv3Gt, ACIv3Le, ACIv3Ge,
} {
	fmt.Printf("%s\n", cop.Context())
}

Output:

Eq
Ne
Lt
Gt
Le
Ge

func (ACIv3Operator) Description ¶

func (r ACIv3Operator) Description() (desc string)

Description returns the string description for the receiver instance:

• "Equal To"
• "Not Equal To"
• "Less Than"
• "Greater Than"
• "Less Than Or Equal"
• "Greater Than Or Equal"

This method is largely for convenience, and many individuals may feel it only has any practical applications in the areas of documentation, diagram creation or some other similar activity.

However, a prudent cybersecurity expert may argue that this method can be used to aid in the (critical) area of proofreading newly-devised or modified access control statements. A person could very easily mistake >= and <=, certainly if they're overworked or not paying attention. One such mistake could spell disaster.

Additionally, use of this method as a means to auto-generate [Instruction] comments (for LDIF configurations, or similar) can greatly help an admin more easily READ and UNDERSTAND the statements in question.

See the ACIv3Operator const definitions for details.

for _, cop := range []ACIv3Operator{
	ACIv3Eq, ACIv3Ne, ACIv3Lt, ACIv3Gt, ACIv3Le, ACIv3Ge,
} {
	fmt.Printf("%s\n", cop.Description())
}

Output:

Equal To
Not Equal To
Less Than
Greater Than
Less Than Or Equal
Greater Than Or Equal

func (ACIv3Operator) String ¶

func (r ACIv3Operator) String() (cop string)

String returns the string representation of the receiver instance.

for _, cop := range []ACIv3Operator{
	ACIv3Eq, ACIv3Ne, ACIv3Lt, ACIv3Gt, ACIv3Le, ACIv3Ge,
} {
	fmt.Printf("%s\n", cop)
}

Output:

=
!=
<
>
<=
>=

func (ACIv3Operator) Valid ¶

func (r ACIv3Operator) Valid() (err error)

Valid returns an error instance following the process of verifying the receiver to be a known ACIv3Operator instance. This does NOT, however, imply feasibility of use with any particular type in the creation of ACIv3BindRule or ACIv3TargetRuleItem instances.

var unknown ACIv3Operator = ACIv3Operator(12)
fmt.Printf("Is a known %T: %t", unknown, unknown.Valid() == nil)

Output:

Is a known dirsyn.ACIv3Operator: false

func (ACIv3Permission) Disposition ¶

func (r ACIv3Permission) Disposition() string

Disposition returns the string disposition `allow` or 'deny', depending on the state of the receiver.

var r NetscapeACIv3
p, err := r.Permission(true, "read", "write", "compare", "selfwrite")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", p.Disposition())

Output:

allow

func (ACIv3Permission) IsZero ¶

func (r ACIv3Permission) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

var p ACIv3Permission
fmt.Printf("Privileges are undefined: %t", p.IsZero())

Output:

Privileges are undefined: true

func (ACIv3Permission) Len ¶

func (r ACIv3Permission) Len() (l int)

Len returns the abstract integer length of the receiver, quantifying the number of ACIv3Right instances currently being expressed. For example, if the receiver instance has its ACIv3ReadAccess and ACIv3DeleteAccess ACIv3Right bits enabled, this would represent an abstract length of two (2).

var r NetscapeACIv3
p, err := r.Permission(false, "read", "write", "compare", "search", "proxy")
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("Number of privileges denied: %d", p.Len())

Output:

Number of privileges denied: 5

func (ACIv3Permission) Positive ¶

func (r ACIv3Permission) Positive(x any) (posi bool)

Positive returns a Boolean value indicative of whether a particular bit is positive (is set). Negation implies negative, or unset.

func (ACIv3Permission) Shift ¶

func (r ACIv3Permission) Shift(x ...any) ACIv3Permission

Shift left-shifts the receiver instance to include ACIv3Right x, if not already present.

func (ACIv3Permission) String ¶

func (r ACIv3Permission) String() string

String returns the string representation of the receiver instance.

var r NetscapeACIv3
p, err := r.Permission(true, "read", "write", "compare", "selfwrite")
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%s", p)

Output:

allow(read,write,compare,selfwrite)

func (ACIv3Permission) Unshift ¶

func (r ACIv3Permission) Unshift(x ...any) ACIv3Permission

Unshift right-shifts the receiver instance to remove ACIv3Right x, if present.

func (ACIv3Permission) Valid ¶

func (r ACIv3Permission) Valid() (err error)

Valid returns a non-error instance if the receiver fails to pass basic validity checks.

var p ACIv3Permission
fmt.Printf("%T is ready for use: %t", p, p.Valid() == nil)

Output:

dirsyn.ACIv3Permission is ready for use: false

func (ACIv3PermissionBindRule) Index ¶

func (r ACIv3PermissionBindRule) Index(idx int) ACIv3PermissionBindRuleItem

Index returns the Nth ACIv3PermissionBindRuleItem slice within the receiver instance.

func (ACIv3PermissionBindRule) IsZero ¶

func (r ACIv3PermissionBindRule) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver instance is nil, or unset.

func (ACIv3PermissionBindRule) Kind ¶

func (r ACIv3PermissionBindRule) Kind() string

Kind returns the string literal `permissionBindRule`.

func (ACIv3PermissionBindRule) Len ¶

func (r ACIv3PermissionBindRule) Len() int

func (ACIv3PermissionBindRule) Push ¶

func (r ACIv3PermissionBindRule) Push(x ...any) ACIv3PermissionBindRule

Push appends zero (0) or more valid instances of ACIv3PermissionBindRuleItem, or the string equivalents.

func (ACIv3PermissionBindRule) String ¶

func (r ACIv3PermissionBindRule) String() string

String returns the string representation of the receiver.

func (ACIv3PermissionBindRule) Valid ¶

func (r ACIv3PermissionBindRule) Valid() (err error)

Valid returns an error instance should any of the following conditions evaluate as true:

• Valid returns an error for P
• Valid returns an error for B
• Len returns zero (0) for B

func (ACIv3PermissionBindRuleItem) BindRule ¶

func (r ACIv3PermissionBindRuleItem) BindRule() ACIv3BindRule

BindRule returns the underlying ACIv3BindRule instance present within the receiver instance.

func (ACIv3PermissionBindRuleItem) IsZero ¶

func (r ACIv3PermissionBindRuleItem) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver instance is nil, or unset.

func (ACIv3PermissionBindRuleItem) Kind ¶

func (r ACIv3PermissionBindRuleItem) Kind() string

Kind returns the string literal `permissionBindRuleItem`.

func (ACIv3PermissionBindRuleItem) Permission ¶

func (r ACIv3PermissionBindRuleItem) Permission() ACIv3Permission

Permission returns the underlying ACIv3Permission instance present within the receiver instance.

func (ACIv3PermissionBindRuleItem) String ¶

func (r ACIv3PermissionBindRuleItem) String() string

String returns the string representation of the receiver.

func (ACIv3PermissionBindRuleItem) Valid ¶

func (r ACIv3PermissionBindRuleItem) Valid() (err error)

Valid returns an error following a validity scan of the receiver instance.

func (ACIv3Right) String ¶

func (r ACIv3Right) String() (p string)

String returns a single string name value for receiver instance.

// iterate all of the known Right definitions
// defined as constants in this package.
for idx, privilege := range []ACIv3Right{
	ACIv3NoAccess,
	ACIv3ReadAccess,
	ACIv3WriteAccess,
	ACIv3AddAccess,
	ACIv3DeleteAccess,
	ACIv3SearchAccess,
	ACIv3CompareAccess,
	ACIv3SelfWriteAccess,
	ACIv3ProxyAccess,
	ACIv3ImportAccess,
	ACIv3ExportAccess,
	ACIv3AllAccess, // does NOT include proxy access !
} {
	fmt.Printf("Privilege %02d/%d: %s (bit:%d)\n", idx+1, 12, privilege, int(privilege))
}

Output:

Privilege 01/12: none (bit:0)
Privilege 02/12: read (bit:1)
Privilege 03/12: write (bit:2)
Privilege 04/12: add (bit:4)
Privilege 05/12: delete (bit:8)
Privilege 06/12: search (bit:16)
Privilege 07/12: compare (bit:32)
Privilege 08/12: selfwrite (bit:64)
Privilege 09/12: proxy (bit:128)
Privilege 10/12: import (bit:256)
Privilege 11/12: export (bit:512)
Privilege 12/12: all (bit:895)

func (ACIv3Scope) Eq ¶

func (r ACIv3Scope) Eq() ACIv3TargetRuleItem

Eq initializes and returns a new ACIv3TargetRuleItem instance configured to express the evaluation of the receiver value as Equal-To an ACIv3TargetScope ACIv3TargetKeyword context.

func (ACIv3Scope) Keyword ¶

func (r ACIv3Scope) Keyword() ACIv3Keyword

Keyword returns the ACIv3Keyword associated with the receiver instance enveloped as a ACIv3Keyword. In the context of this type instance, the ACIv3TargetKeyword returned is always ACIv3TargetScope.

func (ACIv3Scope) Ne ¶

func (r ACIv3Scope) Ne() ACIv3TargetRuleItem

Ne performs no useful task, as negated equality comparison does not apply to ACIv3TargetRuleItem instances that bear the ACIv3TargetScope ACIv3TargetKeyword.

This method exists solely to satisfy Go's interface signature requirements.

This method SHALL NOT appear within instances of ACIv3TargetRuleMethods that were crafted through execution of the ACIv3Scope.TRM method.

func (ACIv3Scope) String ¶

func (r ACIv3Scope) String() string

String returns the string representation of the receiver instance.

func (ACIv3Scope) TRM ¶

func (r ACIv3Scope) TRM() ACIv3TargetRuleMethods

TRM returns an instance of ACIv3TargetRuleMethods.

Each of the return instance's key values represent a single ACIv3Operator that is allowed for use in the creation of ACIv3TargetRuleItem instances which bear the receiver instance as an expression value. The value for each key is the actual instance method to -- optionally -- use for the creation of the ACIv3TargetRuleItem.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3TargetRuleItem instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

func (ACIv3SecurityStrengthFactor) BRM ¶

func (r ACIv3SecurityStrengthFactor) BRM() ACIv3BindRuleMethods

BRM returns an instance of ACIv3BindRuleMethods.

Each of the return instance's key values represent a single instance of the ACIv3Operator type that is allowed for use in the creation of ACIv3BindRule instances which bear the receiver instance as an expression value. The value for each key is the actual ACIv3BindRuleMethod instance for OPTIONAL use in the creation of a ACIv3BindRule instance.

This is merely a convenient alternative to maintaining knowledge of which ACIv3Operator instances apply to which types. Instances of this type are also used to streamline package unit tests.

Please note that if the receiver is in an aberrant state, or if it has not yet been initialized, the execution of ANY of the return instance's value methods will return bogus ACIv3BindRule instances. While this is useful in unit testing, the end user must only execute this method IF and WHEN the receiver has been properly populated and prepared for such activity.

var r NetscapeACIv3

ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}
meths := ssf.BRM()

fmt.Printf("%d available aci.BindRuleMethod instances", meths.Len())

Output:

6 available aci.BindRuleMethod instances

func (ACIv3SecurityStrengthFactor) Eq ¶

func (r ACIv3SecurityStrengthFactor) Eq() ACIv3BindRule

Eq initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Equal-To the ACIv3BindSSF ACIv3BindKeyword context.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Ne().SetParen(true))

Output:

(ssf!="128")

func (ACIv3SecurityStrengthFactor) Ge ¶

func (r ACIv3SecurityStrengthFactor) Ge() ACIv3BindRule

Ge initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Greater-Than-Or-Equal to the ACIv3BindSSF ACIv3BindKeyword context.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Ge().SetParen(true))

Output:

(ssf>="128")

func (ACIv3SecurityStrengthFactor) Gt ¶

func (r ACIv3SecurityStrengthFactor) Gt() ACIv3BindRule

Gt initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Greater-Than the ACIv3BindSSF ACIv3BindKeyword context.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Gt().SetParen(true))

Output:

(ssf>"128")

func (ACIv3SecurityStrengthFactor) IsZero ¶

func (r ACIv3SecurityStrengthFactor) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

var s ACIv3SecurityStrengthFactor
fmt.Printf("Zero: %t", s.IsZero())

Output:

Zero: true

func (ACIv3SecurityStrengthFactor) Keyword ¶

func (r ACIv3SecurityStrengthFactor) Keyword() ACIv3Keyword

Keyword returns the BindKeyword assigned to the receiver instance enveloped as a ACIv3Keyword. This shall be the keyword that appears in a ACIv3BindRule containing the receiver instance as the expression value.

var s ACIv3SecurityStrengthFactor
fmt.Printf("Keyword: %s", s.Keyword())

Output:

Keyword: ssf

func (ACIv3SecurityStrengthFactor) Le ¶

func (r ACIv3SecurityStrengthFactor) Le() ACIv3BindRule

Le initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Less-Than-Or-Equal to the ACIv3BindSSF ACIv3BindKeyword context.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Le().SetParen(true))

Output:

(ssf<="128")

func (ACIv3SecurityStrengthFactor) Lt ¶

func (r ACIv3SecurityStrengthFactor) Lt() ACIv3BindRule

Lt initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Less-Than the ACIv3BindSSF ACIv3BindKeyword context.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Lt())

Output:

ssf<"128"

func (ACIv3SecurityStrengthFactor) Ne ¶

func (r ACIv3SecurityStrengthFactor) Ne() ACIv3BindRule

Ne initializes and returns a new ACIv3BindRule instance configured to express the evaluation of the receiver value as Not-Equal-To the ACIv3BindSSF ACIv3BindKeyword context.

Negated equality ACIv3BindRule instances should be used with caution.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}

fmt.Printf("%s", ssf.Set(128).Ne().SetParen(true))

Output:

(ssf!="128")

func (*ACIv3SecurityStrengthFactor) Set ¶

func (r *ACIv3SecurityStrengthFactor) Set(factor any) ACIv3SecurityStrengthFactor

Set modifies the receiver to reflect the desired security strength factor (SSF), which can represent any numerical value between 0 (off) and 256 (max).

Valid input types are int, string and nil.

A value of nil wipes out any previous value, making the SSF effectively zero (0).

A string value of `full` or `max` sets the SSF to its maximum value. A value of `none` or `off` has the same effect as when providing a nil value. A numerical string value is cast as int and (if valid) will be resubmitted silently. Case is not significant during the string matching process.

An int value less than or equal to zero (0) has the same effect as when providing a nil value. A value between 1 and 256 is acceptable and will be used. A value greater than 256 will be silently reduced back to the maximum.

func (ACIv3SecurityStrengthFactor) String ¶

func (r ACIv3SecurityStrengthFactor) String() string

String returns the string representation of the receiver instance.

var r NetscapeACIv3
ssf, err := r.SecurityStrengthFactor(128)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Printf("%s", ssf)

Output:

128

func (ACIv3SecurityStrengthFactor) Valid ¶

func (r ACIv3SecurityStrengthFactor) Valid() error

Valid returns nil and, at present, does nothing else. Based on the efficient design of the receiver type, there is no possible state that is technically invalid at ALL times. A nil instance may, in fact, be correct in particular situations.

Thus as there is no room for unforeseen errors with regards to this type specifically, this method has been gutted but remains present merely for the purpose of signature consistency throughout the package.

var s ACIv3SecurityStrengthFactor
fmt.Printf("Valid: %t", s.Valid() == nil) // zero IS valid, technically speaking!

Output:

Valid: true

func (ACIv3TargetDistinguishedName) Contains ¶

func (r ACIv3TargetDistinguishedName) Contains(x any) bool

Contains returns a Boolean value indicative of a match between x and a slice value in the receiver instance.

x MUST be a proper DistinguishedName instance, or its string equivalent.

func (ACIv3TargetDistinguishedName) Eq ¶

func (r ACIv3TargetDistinguishedName) Eq() ACIv3TargetRuleItem

Eq returns an instance of ACIv3TargetRuleItem bearing the associated ACIv3TargetKeyword in equality form.

func (ACIv3TargetDistinguishedName) Index ¶

func (r ACIv3TargetDistinguishedName) Index(idx int) string

Index returns the Nth string present within the receiver instance.

func (ACIv3TargetDistinguishedName) IsZero ¶

func (r ACIv3TargetDistinguishedName) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3TargetDistinguishedName) Len ¶

func (r ACIv3TargetDistinguishedName) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3TargetDistinguishedName) Ne ¶

func (r ACIv3TargetDistinguishedName) Ne() ACIv3TargetRuleItem

Ne returns an instance of ACIv3BindRuleItem, enveloped as an ACIv3BindRule, bearing the associated ACIv3BindKeyword in equality form.

Negated equalient ACIv3TargetRuleItem instances should be used with caution.

func (ACIv3TargetDistinguishedName) Push ¶

func (r ACIv3TargetDistinguishedName) Push(x ...any) ACIv3TargetDistinguishedName

Push appends zero (0) or more values to the receiver. Each value MUST be a DistinguishedName, or its string equivalent.

func (ACIv3TargetKeyword) Kind ¶

func (r ACIv3TargetKeyword) Kind() string

Kind returns the static string literal `targetRule` identifying the instance as a ACIv3TargetKeyword.

fmt.Printf("%s", ACIv3TargetAttrFilters.Kind())

Output:

targetRule

func (ACIv3TargetKeyword) String ¶

func (r ACIv3TargetKeyword) String() (k string)

String returns the string representation of the receiver instance of ACIv3TargetKeyword.

fmt.Printf("%s", ACIv3TargetScope)

Output:

targetscope

func (ACIv3TargetRule) Contains ¶

func (r ACIv3TargetRule) Contains(kw any) bool

Contains returns a Boolean value indicative of the presence an instance of ACIv3TargetRuleItem bearing the specified ACIv3TargetKeyword within the receiver instance.

func (ACIv3TargetRule) Index ¶

func (r ACIv3TargetRule) Index(idx int) ACIv3TargetRuleItem

Index returns the Nth instance of ACIv3TargetRuleItem present within the receiver instance.

func (ACIv3TargetRule) IsZero ¶

func (r ACIv3TargetRule) IsZero() bool

func (ACIv3TargetRule) Len ¶

func (r ACIv3TargetRule) Len() int

Len returns the integer length of the receiver instance.

func (ACIv3TargetRule) Push ¶

func (r ACIv3TargetRule) Push(x ...any) ACIv3TargetRule

Push appends zero (0) or more valid ACIv3TargetRuleItem instances to the receiver instance.

If the specified ACIv3TargetRuleItem input instances bear [ACIv3TargetKeyword]s already in use within the receiver instance, they are silently ignored.

Up to nine (9) possible ACIv3TargetRuleItem instances shall appear within any instance of this type.

func (ACIv3TargetRule) SetQuotationStyle ¶

func (r ACIv3TargetRule) SetQuotationStyle(style int) ACIv3TargetRule

SetQuotationStyle performs the iterative equivalent to the ACIv3TargetRuleItem.SetQuotationStyle method, activating the specified quotation style upon all such instances present within the receiver instance.

func (ACIv3TargetRule) String ¶

func (r ACIv3TargetRule) String() string

String returns the string representation of the receiver instance.

func (ACIv3TargetRule) Valid ¶

func (r ACIv3TargetRule) Valid() (err error)

Valid returns an error following an analysis of the receiver instance.

func (ACIv3TargetRuleItem) Expression ¶

func (r ACIv3TargetRuleItem) Expression() any

Expression returns the underlying expression value currently set within the receiver instance.

func (ACIv3TargetRuleItem) IsZero ¶

func (r ACIv3TargetRuleItem) IsZero() bool

IsZero returns a Boolean value indicative of a nil receiver state.

func (ACIv3TargetRuleItem) Keyword ¶

func (r ACIv3TargetRuleItem) Keyword() ACIv3TargetKeyword

Keyword returns the ACIv3TargetKeyword value currently set within the receiver instance.

func (ACIv3TargetRuleItem) Kind ¶

func (r ACIv3TargetRuleItem) Kind() string

Kind returns the string literal `targetRule`.

func (ACIv3TargetRuleItem) Operator ¶

func (r ACIv3TargetRuleItem) Operator() ACIv3Operator

Operator returns the ACIv3Operator value currently set within the receiver instance.

func (ACIv3TargetRuleItem) SetExpression ¶

func (r ACIv3TargetRuleItem) SetExpression(expr any) ACIv3TargetRuleItem

SetExpression assigns value expr to the receiver instance.

func (ACIv3TargetRuleItem) SetKeyword ¶

func (r ACIv3TargetRuleItem) SetKeyword(kw any) ACIv3TargetRuleItem

SetKeyword assigns ACIv3Keyword kw to the receiver instance.

func (ACIv3TargetRuleItem) SetOperator ¶

func (r ACIv3TargetRuleItem) SetOperator(op any) ACIv3TargetRuleItem

SetOperator assigns ACIv3Operator op to the receiver instance.

func (ACIv3TargetRuleItem) SetQuotationStyle ¶

func (r ACIv3TargetRuleItem) SetQuotationStyle(style int) ACIv3TargetRuleItem

SetQuotationStyle allows the election of a particular multivalued quotation style offered by the various adopters of the ACIv3 syntax. In the context of a ACIv3TargetRuleItem, this will only have a meaningful impact if the keyword for the receiver is one (1) of the following:

• ACIv3TargetCtrl (targetcontrol)
• ACIv3TargetExtOp (extop)
• ACIv3Target (target)
• ACIv3TargetTo (target_to)
• ACIv3TargetFrom (target_from)
• ACIv3TargetAttr (targetattr)

Additionally, the underlying type set as the expression value within the receiver MUST be a ACIv3TargetDistinguishedName, ACIv3Attribute or ACIv3ObjectIdentifier instance with two (2) or more values present.

func (ACIv3TargetRuleItem) String ¶

func (r ACIv3TargetRuleItem) String() (s string)

String returns the string representation of the receiver instance.

func (ACIv3TargetRuleItem) Valid ¶

func (r ACIv3TargetRuleItem) Valid() (err error)

Valid returns an error instance which, when non-nil, will indicate a logical flaw, such a missing component of a ACIv3TargetRuleItem qualifier, or some other issue.

func (ACIv3TargetRuleMethods) Contains ¶

func (r ACIv3TargetRuleMethods) Contains(cop any) bool

Contains returns a Boolean value indicative of whether the specified ACIv3Operator, which may be expressed as a string, int or native ACIv3Operator, is allowed for use by the type instance that created the receiver instance. This method offers a convenient alternative to the use of the Index method combined with an assertion value (such as ACIv3Eq, ACIv3Ne, "=", "Greater Than", et al).

In other words, if one uses the ACIv3TargetDistinguishedName's TRM method to create an instance of ACIv3TargetRuleMethods, feeding ACIv3Gt (Greater Than) to this method shall return false, as no ACIv3TargetRuleItem context allows mathematical comparison.

func (ACIv3TargetRuleMethods) Index ¶

func (r ACIv3TargetRuleMethods) Index(idx any) (cop ACIv3Operator, meth ACIv3TargetRuleMethod)

Index calls the input index (idx) within the internal structure of the receiver instance. If found, an instance of ACIv3Operator and its accompanying ACIv3TargetRuleMethod instance are returned.

Valid input index types are integer (int), ACIv3Operator constant or string identifier. In the case of a string identifier, valid values are as follows:

• For ACIv3Eq (1): `=`, `Eq`, `Equal To`
• For ACIv3Ne (2): `=`, `Ne`, `Not Equal To`
• For ACIv3Lt (3): `=`, `Lt`, `Less Than`
• For ACIv3Le (4): `=`, `Le`, `Less Than Or Equal`
• For ACIv3Gt (5): `=`, `Gt`, `Greater Than`
• For ACIv3Ge (6): `=`, `Ge`, `Greater Than Or Equal`

Case is not significant in the string matching process.

Please note that use of this method by way of integer or ACIv3Operator values utilizes fewer resources than a string lookup.

See the ACIv3Operator.Context, ACIv3Operator.String and ACIv3Operator.Description methods for accessing the above string values easily.

If the index was not matched, an invalid ACIv3Operator is returned alongside a nil ACIv3TargetRuleMethod. This will also apply to situations in which the type instance which crafted the receiver is uninitialized, or is in an otherwise aberrant state.

func (ACIv3TargetRuleMethods) IsZero ¶

func (r ACIv3TargetRuleMethods) IsZero() bool

IsZero returns a Boolean value indicative of whether the receiver is nil, or unset.

func (ACIv3TargetRuleMethods) Len ¶

func (r ACIv3TargetRuleMethods) Len() int

Len returns the integer length of the receiver. Note that the return value will NEVER be less than zero (0) nor greater than six (6).

func (ACIv3TargetRuleMethods) Valid ¶

func (r ACIv3TargetRuleMethods) Valid() (err error)

Valid returns the first encountered error returned as a result of execution of the first available ACIv3TargetRuleMethod instance. This is useful in cases where a user wants to see if the desired instance(s) of ACIv3TargetRuleMethod will produce a usable result.

func (ACIv3TimeOfDay) BRM ¶