Struct DepthHeader

The representation of the Depth header

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace:FubarDev.WebDavServer.Model.Headers

Assembly:FubarDev.WebDavServer.dll

Syntax

public struct DepthHeader : IComparable<DepthHeader>, IEquatable<DepthHeader>

Fields

| Improve this Doc View Source

Infinity

Gets the default infinity depth header

Declaration

public static readonly DepthHeader Infinity

Field Value

Type	Description
DepthHeader

| Improve this Doc View Source

One

Gets the default 1 depth header

Declaration

public static readonly DepthHeader One

Field Value

Type	Description
DepthHeader

| Improve this Doc View Source

Zero

Gets the default 0 depth header

Declaration

public static readonly DepthHeader Zero

Field Value

Type	Description
DepthHeader

Properties

| Improve this Doc View Source

OrderValue

Gets the ordinal value of the depth represented by this depth header instance

Declaration

public int OrderValue { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Value

Gets the textual value of the depth header as given in the HTTP header

Declaration

public string Value { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

XmlValue

Gets the object used in XML de-/serialization

Declaration

public activelockDepth XmlValue { get; }

Property Value

Type	Description
activelockDepth

Methods

| Improve this Doc View Source

CompareTo(DepthHeader)

Declaration

public int CompareTo(DepthHeader other)

Parameters

Type	Name	Description
DepthHeader	other

Returns

Type	Description
Int32

Implements

IComparable<T>.CompareTo(T)

| Improve this Doc View Source

Equals(DepthHeader)

Declaration

public bool Equals(DepthHeader other)

Parameters

Type	Name	Description
DepthHeader	other

Returns

Type	Description
Boolean

Implements

IEquatable<T>.Equals(T)

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

| Improve this Doc View Source

Parse(String)

Parses the given depth header value and returns the corresponding DepthHeader instance.

Declaration

public static DepthHeader Parse(string depth)

Parameters

Type	Name	Description
String	depth	The depth header to parse

Returns

Type	Description
DepthHeader	The corresponding DepthHeader

| Improve this Doc View Source

Parse(String, DepthHeader)

Parses the given depth header value and returns the corresponding DepthHeader instance.

Declaration

public static DepthHeader Parse(string depth, DepthHeader defaultDepth)

Parameters

Type	Name	Description
String	depth	The depth header to parse
DepthHeader	defaultDepth	The default depth header to use when the depth is empty

Returns

Type	Description
DepthHeader	The corresponding DepthHeader

| Improve this Doc View Source

TryParse(String, DepthHeader, out DepthHeader)

Tries to parse the depth header value

Declaration

public static bool TryParse(string depthText, DepthHeader defaultDepth, out DepthHeader depth)

Parameters

Type	Name	Description
String	depthText	The depth header value
DepthHeader	defaultDepth	The default depth header to use when the depthText is empty
DepthHeader	depth	The found depth header

Returns

Type	Description
Boolean	`true` when the value could be parsed

| Improve this Doc View Source

TryParse(String, out DepthHeader)

Tries to parse the depth header value

Declaration

public static bool TryParse(string depthText, out DepthHeader depth)

Parameters

Type	Name	Description
String	depthText	The depth header value
DepthHeader	depth	The found depth header

Returns

Type	Description
Boolean	`true` when the value could be parsed

Operators

| Improve this Doc View Source

Equality(DepthHeader, DepthHeader)

Compares two depth headers for their equality

Declaration

public static bool operator ==(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when both depth headers are of equal value

| Improve this Doc View Source

GreaterThan(DepthHeader, DepthHeader)

Compares if the x depth header is of greater ordinal value than the y depth header

Declaration

public static bool operator>(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when the x depth header is of greater ordinal value than the y depth header

| Improve this Doc View Source

GreaterThanOrEqual(DepthHeader, DepthHeader)

Compares if the x depth header is of the same or greater ordinal value than the y depth header

Declaration

public static bool operator >=(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when the x depth header is of the same or greater ordinal value than the y depth header

| Improve this Doc View Source

Inequality(DepthHeader, DepthHeader)

Compares two depth headers for their inequality

Declaration

public static bool operator !=(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when both depth headers are not of equal value

| Improve this Doc View Source

LessThan(DepthHeader, DepthHeader)

Compares if the x depth header is of lower ordinal value than the y depth header

Declaration

public static bool operator <(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when the x depth header is of lower ordinal value than the y depth header

| Improve this Doc View Source

LessThanOrEqual(DepthHeader, DepthHeader)

Compares if the x depth header is of the same or lower ordinal value than the y depth header

Declaration

public static bool operator <=(DepthHeader x, DepthHeader y)

Parameters

Type	Name	Description
DepthHeader	x	The first depth header to compare
DepthHeader	y	The second depth header to compare

Returns

Type	Description
Boolean	true when the x depth header is of the same or lower ordinal value than the y depth header