Struct DepthHeader
The representation of the Depth
header
Inherited Members
Namespace:FubarDev.WebDavServer.Model.Headers
Assembly:FubarDev.WebDavServer.dll
Syntax
public struct DepthHeader : IComparable<DepthHeader>, IEquatable<DepthHeader>
Fields
| Improve this Doc View SourceInfinity
Gets the default infinity
depth header
Declaration
public static readonly DepthHeader Infinity
Field Value
Type | Description |
---|---|
DepthHeader |
One
Gets the default 1
depth header
Declaration
public static readonly DepthHeader One
Field Value
Type | Description |
---|---|
DepthHeader |
Zero
Gets the default 0
depth header
Declaration
public static readonly DepthHeader Zero
Field Value
Type | Description |
---|---|
DepthHeader |
Properties
| Improve this Doc View SourceOrderValue
Gets the ordinal value of the depth represented by this depth header instance
Declaration
public int OrderValue { get; }
Property Value
Type | Description |
---|---|
Int32 |
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 |
XmlValue
Gets the object used in XML de-/serialization
Declaration
public activelockDepth XmlValue { get; }
Property Value
Type | Description |
---|---|
activelockDepth |
Methods
| Improve this Doc View SourceCompareTo(DepthHeader)
Declaration
public int CompareTo(DepthHeader other)
Parameters
Type | Name | Description |
---|---|---|
DepthHeader | other |
Returns
Type | Description |
---|---|
Int32 |
Implements
| Improve this Doc View SourceEquals(DepthHeader)
Declaration
public bool Equals(DepthHeader other)
Parameters
Type | Name | Description |
---|---|---|
DepthHeader | other |
Returns
Type | Description |
---|---|
Boolean |
Implements
| Improve this Doc View SourceEquals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj |
Returns
Type | Description |
---|---|
Boolean |
Overrides
| Improve this Doc View SourceGetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 |
Overrides
| Improve this Doc View SourceParse(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 |
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 |
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 |
|
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 |
|
Operators
| Improve this Doc View SourceEquality(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 |
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 |
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 |
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 |
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 |
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 |