System.Net.Http.Headers.RangeHeader

Summary

Represents the value of the Range header in an HTTP request.

This header is used to request a partial response by specifying a byte range or a set of byte ranges for the requested resource.

Inheritance

System.Object
System.Net.Http.Headers.RangeHeader

Constructors

public RangeHeader(long from, long to)

Initializes a new instance of the RangeHeader class with a single byte range.
Parameters
- from: The starting byte position of the range (inclusive).
- to: The ending byte position of the range (inclusive).
public RangeHeader(string unit, long from, long to)

Initializes a new instance of the RangeHeader class with a specified unit and a single byte range.
Parameters
- unit: The unit of the range (e.g., "bytes").
- from: The starting byte position of the range (inclusive).
- to: The ending byte position of the range (inclusive).

Properties

public long From { get; }

Gets the starting byte position of the range.
public long? Length { get; }

Gets the length of the range. If the range is open-ended (e.g., 100-), this property will be null.
public string Unit { get; }

Gets the unit of the range (e.g., "bytes").
public long? To { get; }

Gets the ending byte position of the range. If the range is open-ended (e.g., 100-), this property will be null.

Methods

public override string ToString()

Returns a string representation of the RangeHeader object.
public static RangeHeader Parse(string input)

Parses a string representation of a Range header and returns an instance of the RangeHeader class.
Parameters
- input: The string to parse.
Returns

A RangeHeader instance representing the parsed input.
public static bool TryParse(string input, [out] RangeHeader out rangeHeader)

Tries to parse a string representation of a Range header and returns a value indicating whether the operation succeeded.
Parameters
- input: The string to parse.
- rangeHeader: When this method returns, contains the RangeHeader instance if the parse succeeded, or null otherwise.
Returns

true if the string was parsed successfully; otherwise, false.

Remarks

The RangeHeader class is used to represent the value of the HTTP Range header. This header allows clients to request a portion of a resource, rather than the entire resource. This is commonly used for resuming interrupted downloads or for streaming media.

A typical Range header looks like this:

Range: bytes=0-999
            

This requests the first 1000 bytes of the resource. The RangeHeader class can parse and represent such values.

The Unit property specifies the unit of the range, commonly bytes. The From and To properties represent the start and end of the byte range. If the end is not specified (e.g., 100-), the To property will be null.

Example

using System.Net.Http.Headers;

public class Example
{
    public static void Main()
    {
        // Create a RangeHeader for the first 1024 bytes
        RangeHeader range1 = new RangeHeader(0, 1023);
        Console.WriteLine("Range 1: " + range1); // Output: bytes=0-1023

        // Create a RangeHeader for bytes from 500 onwards
        RangeHeader range2 = new RangeHeader("bytes", 500, null);
        Console.WriteLine("Range 2: " + range2); // Output: bytes=500-

        // Parse a Range Header string
        string headerString = "bytes=200-399";
        RangeHeader parsedRange;
        if (RangeHeader.TryParse(headerString, out parsedRange))
        {
            Console.WriteLine("Parsed Range Unit: " + parsedRange.Unit); // Output: bytes
            Console.WriteLine("Parsed Range From: " + parsedRange.From); // Output: 200
            Console.WriteLine("Parsed Range To: " + parsedRange.To); // Output: 399
        }
        else
        {
            Console.WriteLine("Failed to parse range header.");
        }
    }
}
            

RangeHeader Class

Summary

Inheritance

Constructors

Parameters

Parameters

Properties

Methods

Parameters

Returns

Parameters

Returns

Remarks

Example