Index Documentation

Index

Table of Contents

Interfaces

IBencodeSerialisable
Provides an interface for serialising objects for bencoding in a controlled manner.
ICacheBackend
Information about a cache provider. Should not have any external dependencies.
ICacheProvider
Represents a cache provider.
ICacheProviderInfo
Base type for cache provider info.
IDbBackend
Information about a database layer. Should not have any external dependencies.
IDbConnection
Represents a connection to a database service.
IDbConnectionInfo
Base type for database connection info.
IDbResult
Represents a database result set.
IDbStatement
Represents a prepared database statement.
IDbTransactions
Indicates supports for transactions in a database connection.
IDbMigration
Interface for migration classes to inherit.
IDbMigrationInfo
Information on a migration repository item.
IDbMigrationRepo
Represents a repository of migrations.
IHttpContent
Represents the body content for a HTTP message.
IContentHandler
Represents a content handler for building HTTP response messages.
IErrorHandler
Represents an error message handler for building HTTP response messages.
IRouteHandler
Provides the interface for IRouter::register().
IRouter
ICloseable
Provides an interface for releasing unmanaged resources.
IComparable
Provides an interface for comparison between objects. Allows for order/sorting instances.
IEquatable
Provides an interface for determining the value-equality of two objects.

Classes

ArrayIterator
Provides an Iterator implementation for normal arrays.
Base32
Provides Base32 encoding.
Bencode
Provides a Bencode serialiser.
ByteFormat
Implements a byte formatter for file sizes.
ArrayCacheBackend
Information about the dummy cache backend.
ArrayCacheProvider
Represents a dummy cache provider.
ArrayCacheProviderInfo
Represents dummy provider info.
CacheTools
Common cache actions.
MemcachedBackend
Information about the memcached backend.
MemcachedProvider
Base Memcached provider implementation.
MemcachedProviderInfo
Represents Memcached provider info.
MemcachedProviderLegacy
Legacy Memcached provider implementation.
MemcachedProviderModern
Base Memcached provider implementation.
ValkeyBackend
Information about the Valkey backend.
ValkeyProvider
Valkey provider implementation.
ValkeyProviderInfo
Represents Valkey provider info.
Colour
Abstract class for representing colours.
ColourHSL
Represents a colour using Hue, Saturation and Lightness.
ColourNamed
Represents a named CSS colour.
ColourNull
Represents an empty colour.
ColourRGB
Represents an RGB colour.
CSRFP
Contains a mechanism for validating requests.
DbResultIterator
Implements an iterator and constructor wrapper for IDbResult.
DbStatementCache
Container to avoid having many prepared instances of the same query.
DbTools
Common database actions.
DbType
Map of common database types.
MariaDBBackend
Information about the MariaDB/MySQL database layer.
MariaDBCharacterSetInfo
Contains information about the character set.
MariaDBConnection
Represents a connection with a MariaDB or MySQL database server.
MariaDBConnectionInfo
Describes a MariaDB or MySQL connection.
MariaDBParameter
Represents a bound parameter.
MariaDBResult
Represents a MariaDB/MySQL database result.
MariaDBStatement
Represents a MariaDB/MySQL prepared statement.
MariaDBWarning
Represents a MariaDB/MySQL warning.
DbMigrationManager
Provides a common interface for database migrations.
FsDbMigrationInfo
FsDbMigrationRepo
NullDbBackend
Information about the dummy database layer.
NullDbConnection
Represents a dummy database connection.
NullDbConnectionInfo
Represents dummy connection info.
NullDbResult
Represents a dummy database result.
NullDbStatement
Represents a dummy database statement.
SQLiteBackend
Information about the SQLite 3 database layer.
SQLiteConnection
Represents a client for an SQLite database.
SQLiteConnectionInfo
Represents information about a SQLite Client.
SQLiteResult
Represents an SQLite result set.
SQLiteStatement
Represents a prepared SQLite SQL statement.
BencodedContent
Represents Bencoded body content for a HTTP message.
FormContent
Represents form body content for a HTTP message.
JsonContent
Represents JSON body content for a HTTP message.
StreamContent
Represents Stream body content for a HTTP message.
StringContent
Represents string body content for a HTTP message.
BencodeContentHandler
Represents a Bencode content handler for building HTTP response messages.
JsonContentHandler
Represents a JSON content handler for building HTTP response messages.
StreamContentHandler
Represents a Stream content handler for building HTTP response messages.
HtmlErrorHandler
Represents a basic HTML error message handler for building HTTP response messages.
PlainErrorHandler
Represents a plain text error message handler for building HTTP response messages.
HttpHeader
Represents a generic HTTP header.
HttpHeaders
Represents a collection of HTTP headers.
HttpHeadersBuilder
Represents a HTTP message header builder.
HttpMessage
Represents a base HTTP message.
HttpMessageBuilder
Represents a base HTTP message builder.
HttpRequest
Represents a HTTP request message.
HttpRequestBuilder
Represents a HTTP request message builder.
HttpResponse
Represents a HTTP response message.
HttpResponseBuilder
Represents a HTTP response message builder.
HttpUploadedFile
Represents an uploaded file in a multipart/form-data request.
HandlerAttribute
Provides base for attributes that mark methods in a class as handlers.
HttpDelete
Provides an attribute for marking methods in a class as a DELETE route.
HttpGet
Provides an attribute for marking methods in a class as a GET route.
HttpMiddleware
Provides an attribute for marking methods in a class as middleware.
HttpOptions
Provides an attribute for marking methods in a class as a OPTIONS route.
HttpPatch
Provides an attribute for marking methods in a class as a POST route.
HttpPost
Provides an attribute for marking methods in a class as a POST route.
HttpPut
Provides an attribute for marking methods in a class as a PUT route.
HttpRoute
Provides an attribute for marking methods in a class as a route.
HttpRouter
ResolvedRouteInfo
Represents a resolved route.
RouteHandler
Provides an abstract class version of IRouteHandler that already includes the trait as well, letting you only have to use one use statement rather than two!
ScopedRouter
Provides a scoped router interface, automatically adds a prefix to any routes added.
Index
Provides information about the Index library.
IntegerBaseConverter
Provides methods for encoding integers in different bases.
FileStream
Represents a Stream representing a file.
GenericStream
Represents any stream that can be handled using the C-like f* functions.
MemoryStream
Represents an in-memory stream.
NetworkStream
Represents a network socket stream.
ProcessStream
Represents a stream to a running sub-process.
Stream
Represents a generic data stream.
TempFileStream
Represents a temporary file stream. Will remain in memory if the size is below a given threshold.
MediaType
Implements a structure for representing and comparing media/mime types.
DnsEndPoint
A DNS end point.
EndPoint
Represents a generic network end point.
IPAddress
Represents an IP address.
IPAddressRange
Represents a CIDR range of IP addresses.
IPEndPoint
Represents an IP address end point.
UnixEndPoint
Represents a UNIX socket path end point.
PerformanceCounter
Represents a performance counter.
Stopwatch
Provides a means to measure elapsed time at a high resolution.
TimingPoint
Represents a timing point.
Timings
Represents a Stopwatch with timing points.
UriBase64
Provides URL-safe Base64 encoding.
WString
Provides various helper methods for multibyte strings.
XArray
Provides various helper methods for collections.
XDateTime
Provides a set of DateTime related utilities.
XNumber
Provides various helper methods for numbers.
XString
Provides various helper methods for strings.

Traits

DbResultTrait
Implements common IDbResult methods.
RouteHandlerTrait
Provides an implementation of IRouteHandler::registerRoutes that uses the attributes.
RouterTrait
Contains implementations for HTTP request method handler registration.

        
On this page

Search results