TAttributeVerifier
Represents the set of attributes that are required when the service is opened.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| Handle |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| Attributes | Returns the underlying required TAttributeSetView |
| Keys | Returns the underlying required keys |
| New | Creates a new TAttributeVerifier. |
| Require | Requires a value for a specific key. A key is allowed to have multiple values. |
| RequireKey | Requires that a specific key is defined. |
| RequireKeyUtf8 | Requires that a specific key is defined. |
| RequireUtf8 | Requires a value for a specific key. A key is allowed to have multiple values. |
| VerifyRequirements | Verifies if the TAttributeSet contains all required keys and key-value pairs. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
Constructor Descriptions
Assign
constructor Assign(var ADest: TAttributeVerifier; const ASrc: TAttributeVerifier)
Parameters
ADest: TAttributeVerifier
ASrc: TAttributeVerifier
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TAttributeVerifier, Pointer)
class operator Equal(const ALeft: TAttributeVerifier; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TAttributeVerifier
ARight: Pointer
Returns
Boolean
NotEqual(TAttributeVerifier, Pointer)
class operator NotEqual(const ALeft: TAttributeVerifier; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TAttributeVerifier
ARight: Pointer
Returns
Boolean
Method Descriptions
Attributes
Returns the underlying required TAttributeSetView
function Attributes: TAttributeSetView; inline
Returns
Keys
Returns the underlying required keys
function Keys: TArray<String>
Returns
TArray<String>
New
Creates a new TAttributeVerifier.
class function New: TAttributeVerifier; inline; static
Returns
Require(String, String)
Requires a value for a specific key. A key is allowed to have multiple values.
function Require(const AKey, AValue: String): TResult<Void, TAttributeDefinitionError>
Parameters
AKey: String
AValue: String
Returns
TResult<Void, TAttributeDefinitionError>
Remarks
Use RequireUtf8 for a more efficient version that doesn't require UTF-8 conversion.
RequireKey(String)
Requires that a specific key is defined.
function RequireKey(const AKey: String): TResult<Void, TAttributeDefinitionError>
Parameters
AKey: String
Returns
TResult<Void, TAttributeDefinitionError>
Remarks
Use RequireKeyUtf8 for a more efficient version that doesn't require UTF-8 conversion.
RequireKeyUtf8(UTF8String)
Requires that a specific key is defined.
function RequireKeyUtf8(const AKey: UTF8String): TResult<Void, TAttributeDefinitionError>; inline
Parameters
AKey: UTF8String
Returns
TResult<Void, TAttributeDefinitionError>
RequireUtf8(UTF8String, UTF8String)
Requires a value for a specific key. A key is allowed to have multiple values.
function RequireUtf8(const AKey, AValue: UTF8String): TResult<Void, TAttributeDefinitionError>; inline
Parameters
AKey: UTF8String
AValue: UTF8String
Returns
TResult<Void, TAttributeDefinitionError>
VerifyRequirements(TAttributeSetView)
Verifies if the TAttributeSet contains all required keys and key-value pairs.
function VerifyRequirements(const AOther: TAttributeSetView): TResult<Void, TAttributeVerificationError>
Parameters
AOther: TAttributeSetView
Returns
TResult<Void, TAttributeVerificationError>