OptionsModel

public sealed class OptionsModel

Namespace: RhoMicro.BindSight.Models

Inheritance:

• DirectoryOptionsModel

  • Object
  • IEquatable<OptionsModel>

Summary

Represents an options registration.

Constructors

OptionsModel(OptionsModelRoot, ImmutableHashSet<OptionsModelChild>, EnrichmentFactory)

public OptionsModel(OptionsModelRoot root, ImmutableHashSet<OptionsModelChild> children, EnrichmentFactory enrichmentFactory)

Summary

Initializes a new instance.

Parameters

Name	Type	Description
children	ImmutableHashSet<OptionsModelChild>	The models of bound object graphs defined by root properties.
enrichmentFactory	EnrichmentFactory	The factory used to create enrichments to the new model instance.
root	OptionsModelRoot	The model of the registered options type.

OptionsModel(OptionsModelRoot, EnrichmentFactory)

public OptionsModel(OptionsModelRoot root, EnrichmentFactory enrichmentFactory)

Summary

Initializes a new instance.

Parameters

Name	Type	Description
enrichmentFactory	EnrichmentFactory	The factory used to create enrichments to the new model instance.
root	OptionsModelRoot	The model of the registered options type.

OptionsModel(OptionsModelRoot, ImmutableHashSet<OptionsModelChild>, EnrichmentFactory, ConcurrentDictionary<Type, object>)

private OptionsModel(OptionsModelRoot root, ImmutableHashSet<OptionsModelChild>? children, EnrichmentFactory enrichmentFactory, ConcurrentDictionary<Type, object> enrichments)

Properties

Root

public OptionsModelRoot Root { get; }

Summary

Gets the model of the registered options type.

Children

public ImmutableHashSet<OptionsModelChild> Children { get; }

Summary

Gets the models of bound object graphs defined by root properties.

Methods

WithRoot(OptionsModelRoot)

public OptionsModel WithRoot(OptionsModelRoot root)

Summary

Creates a copy of this instance with OptionsModel.Root replaced.

Parameters

Name	Type	Description
root	OptionsModelRoot	The value to replace OptionsModel.Root with.

Returns

A copy of this instance with OptionsModel.Root replaced by root.

WithChildren(ImmutableHashSet<OptionsModelChild>)

public OptionsModel WithChildren(ImmutableHashSet<OptionsModelChild> children)

Summary

Creates a copy of this instance with OptionsModel.Children replaced.

Parameters

Name	Type	Description
children	ImmutableHashSet<OptionsModelChild>	The value to replace OptionsModel.Children with.

Returns

A copy of this instance with OptionsModel.Children replaced by children.

GetEnrichment<TEnrichment>()

public TEnrichment GetEnrichment<TEnrichment>() where TEnrichment : IOptionsModelEnrichment<TEnrichment>

Summary

Gets an instance of the specified enrichment type. If an instance of the enrichment type is already attached to this instance, it is returned; otherwise, a new instance of the enrichment will be created and attached to this instance.

Type Parameters

Name	Description	Constraints
TEnrichment	The type of enrichment to get.	IOptionsModelEnrichment<TEnrichment>

Returns

The instance of TEnrichment attached to this instance.

WithEnrichment<TEnrichment>(TEnrichment)

public OptionsModel WithEnrichment<TEnrichment>(TEnrichment enrichment) where TEnrichment : IOptionsModelEnrichment<TEnrichment>

Summary

Gets a copy of this instance with the specified type of enrichment replaced.

Type Parameters

Name	Description	Constraints
TEnrichment	The type of enrichment to attach to the returned copy.	IOptionsModelEnrichment<TEnrichment>

Parameters

Name	Type	Description
enrichment	TEnrichment	The enrichment to attach to the returned copy.

Returns

A copy of this instance with the TEnrichment replaced by enrichment.

Create(Type, EnrichmentFactory)

public static OptionsModel Create(Type type, EnrichmentFactory enrichmentFactory)

Summary

Creates a new instance using default creation options.

Parameters

Name	Type	Description
enrichmentFactory	EnrichmentFactory	The enrichment factory to be used by the created instance when creating enrichments.
type	Type	The options type to model.

Returns

A new model of the options type.

Create(Type, EnrichmentFactory, OptionsModelCreationOptions)

public static OptionsModel Create(Type type, EnrichmentFactory enrichmentFactory, OptionsModelCreationOptions options)

Summary

Creates a new instance.

Parameters

Name	Type	Description
enrichmentFactory	EnrichmentFactory	The enrichment factory to be used by the created instance when creating enrichments.
options	OptionsModelCreationOptions	The options to use when creating the model.
type	Type	The options type to model.

Returns

A new model of the options type.

ToString()

public override string ToString()

Summary

Returns a string that represents the current object.

Returns

A string that represents the current object.

Equals(object)

public override bool Equals(object? obj)

Summary

Determines whether the specified object is equal to the current object.

Parameters

Name	Type	Description
obj	Object	The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

Equals(OptionsModel)

public bool Equals(OptionsModel? other)

GetHashCode()

public override int GetHashCode()

Summary

Serves as the default hash function.

Returns

A hash code for the current object.