OptionsModelChild

public sealed class OptionsModelChild

Namespace: RhoMicro.BindSight.Models

Inheritance:

• DirectoryOptionsModelChild

  • Object
  • IEquatable<OptionsModelChild>

Summary

Models a direct or indirect property or generic argument of a registered options type.

Constructors

OptionsModelChild(PropertyInfo, OptionsModel, OptionsModelChild, EnrichmentFactory)

public OptionsModelChild(PropertyInfo property, OptionsModel model, OptionsModelChild? parent, EnrichmentFactory enrichmentFactory)

Summary

Initializes a new instance.

Parameters

Name	Type	Description
enrichmentFactory	EnrichmentFactory	The factory used to create enrichments to the new model instance.
model	OptionsModel	The model containing the root to this property.
parent	OptionsModelChild	The parent to this child.
property	PropertyInfo	The property to model.

OptionsModelChild(Type, OptionsModel, OptionsModelChild, EnrichmentFactory)

public OptionsModelChild(Type genericArgumentType, OptionsModel model, OptionsModelChild? parent, EnrichmentFactory enrichmentFactory)

Summary

Initializes a new instance.

Parameters

Name	Type	Description
enrichmentFactory	EnrichmentFactory	The factory used to create enrichments to the new model instance.
genericArgumentType	Type	The generic argument type to model.
model	OptionsModel	The model containing the root to this property.
parent	OptionsModelChild	The parent to this child.

OptionsModelChild(ConcurrentDictionary<Type, object>, EnrichmentFactory, PropertyInfo, Type, OptionsModelChild, OptionsModel)

private OptionsModelChild(ConcurrentDictionary<Type, object> enrichments, EnrichmentFactory enrichmentFactory, PropertyInfo? property, Type? genericArgumentType, OptionsModelChild? parent, OptionsModel model)

Properties

Property

public PropertyInfo? Property { get; }

Summary

Gets the property info modelled by this instance, if it is modelling one; otherwise, null.

GenericArgumentType

public Type? GenericArgumentType { get; }

Summary

Gets the generic type argument modelled by this instance, if it is modelling one; otherwise, null.

Parent

public OptionsModelChild? Parent { get; }

Summary

Gets the parent containing this model if it is contained in one; otherwise, null.

Model

public OptionsModel Model { get; }

Summary

Gets the options model containing the root defining this child.

ModelledType

public Type ModelledType { get; }

Summary

Gets the type of the modelled property or the modelled type.

Methods

GetFirstCustomAttribute<TAttribute>(bool)

public TAttribute? GetFirstCustomAttribute<TAttribute>([bool inherit = false]) where TAttribute : Attribute

Summary

Gets the first found custom attribute of type TAttributeon either OptionsModelChild.Property or OptionsModelChild.GenericArgumentType, depending on which is being modelled by this instance.

Type Parameters

Name	Description	Constraints
T	The type of attribute to search for.
TAttribute	The type of attribute to look for.	Attribute

Parameters

Name	Type	Description
element		The member to inspect.
inherit	Boolean	true to inspect the ancestors of element; otherwise, false.

Returns

The first found attribute of type TAttribute, if one could be found; otherwise, null.

Exceptions

####### TypeLoadException

A custom attribute type cannot be loaded.####### AmbiguousMatchException

More than one of the requested attributes was found.####### NotSupportedException

element is not a constructor, method, property, event, type, or field.####### ArgumentNullException

element is null.

GetCustomAttributes<TAttribute>(bool)

public ImmutableArray<TAttribute> GetCustomAttributes<TAttribute>([bool inherit = false]) where TAttribute : Attribute

Summary

Gets all custom attribute of type TAttributeon either OptionsModelChild.Property or OptionsModelChild.GenericArgumentType, depending on which is being modelled by this instance.

Type Parameters

Name	Description	Constraints
T	The type of attribute to search for.
TAttribute	The type of attribute to look for.	Attribute

Parameters

Name	Type	Description
element		The member to inspect.
inherit	Boolean	true to inspect the ancestors of element; otherwise, false.

Returns

All attributes of type TAttribute, if one could be found; otherwise, null.

Exceptions

####### TypeLoadException

A custom attribute type cannot be loaded.####### AmbiguousMatchException

More than one of the requested attributes was found.####### NotSupportedException

element is not a constructor, method, property, event, type, or field.####### ArgumentNullException

element is null.

GetEnrichment<TEnrichment>()

public TEnrichment GetEnrichment<TEnrichment>() where TEnrichment : notnull, IOptionsModelChildEnrichment<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.	notnull, IOptionsModelChildEnrichment<TEnrichment>

Returns

The instance of TEnrichment attached to this instance.

WithEnrichment<TEnrichment>(TEnrichment)

public OptionsModelChild WithEnrichment<TEnrichment>(TEnrichment enrichment) where TEnrichment : IOptionsModelChildEnrichment<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.	IOptionsModelChildEnrichment<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.

GetHashCode()

public override int GetHashCode()

Summary

Serves as the default hash function.

Returns

A hash code for 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(OptionsModelChild)

public bool Equals(OptionsModelChild? other)