| 1 |
types |
| 2 |
===== |
| 3 |
|
| 4 |
.. module:: litestar.types |
| 5 |
|
| 6 |
|
| 7 |
|
| 8 |
Callable types |
| 9 |
-------------- |
| 10 |
|
| 11 |
|
| 12 |
.. autodata:: litestar.types.AfterExceptionHookHandler |
| 13 |
|
| 14 |
.. autodata:: litestar.types.AfterRequestHookHandler |
| 15 |
|
| 16 |
.. autodata:: litestar.types.AfterResponseHookHandler |
| 17 |
|
| 18 |
.. autodata:: litestar.types.AnyCallable |
| 19 |
|
| 20 |
.. autodata:: litestar.types.AsyncAnyCallable |
| 21 |
|
| 22 |
.. autodata:: litestar.types.BeforeMessageSendHookHandler |
| 23 |
|
| 24 |
.. autodata:: litestar.types.BeforeRequestHookHandler |
| 25 |
|
| 26 |
.. autodata:: litestar.types.CacheKeyBuilder |
| 27 |
|
| 28 |
.. autodata:: litestar.types.ExceptionHandler |
| 29 |
|
| 30 |
.. autodata:: litestar.types.Guard |
| 31 |
|
| 32 |
.. autodata:: litestar.types.LifespanHook |
| 33 |
|
| 34 |
.. autodata:: litestar.types.OnAppInitHandler |
| 35 |
|
| 36 |
.. autodata:: litestar.types.Serializer |
| 37 |
|
| 38 |
|
| 39 |
ASGI Types |
| 40 |
---------- |
| 41 |
|
| 42 |
.. autodata:: litestar.types.Method |
| 43 |
|
| 44 |
ASGI Application |
| 45 |
~~~~~~~~~~~~~~~~~ |
| 46 |
|
| 47 |
.. autodata:: litestar.types.ASGIApp |
| 48 |
|
| 49 |
ASGI Application Parameters |
| 50 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 51 |
|
| 52 |
.. autodata:: litestar.types.Scope |
| 53 |
|
| 54 |
.. autodata:: litestar.types.Receive |
| 55 |
|
| 56 |
.. autodata:: litestar.types.Send |
| 57 |
|
| 58 |
ASGI Scopes |
| 59 |
~~~~~~~~~~~~ |
| 60 |
|
| 61 |
.. autoclass:: litestar.types.ASGIVersion |
| 62 |
|
| 63 |
.. autoclass:: litestar.types.BaseScope |
| 64 |
|
| 65 |
.. autoclass:: litestar.types.HTTPScope |
| 66 |
|
| 67 |
.. autoclass:: litestar.types.LifeSpanScope |
| 68 |
|
| 69 |
.. autoclass:: litestar.types.WebSocketScope |
| 70 |
|
| 71 |
|
| 72 |
ASGI Events |
| 73 |
~~~~~~~~~~~~ |
| 74 |
|
| 75 |
.. autoclass:: litestar.types.HTTPRequestEvent |
| 76 |
|
| 77 |
.. autoclass:: litestar.types.HTTPResponseStartEvent |
| 78 |
|
| 79 |
.. autoclass:: litestar.types.HTTPResponseBodyEvent |
| 80 |
|
| 81 |
.. autoclass:: litestar.types.HTTPServerPushEvent |
| 82 |
|
| 83 |
.. autoclass:: litestar.types.HTTPDisconnectEvent |
| 84 |
|
| 85 |
.. autoclass:: litestar.types.WebSocketConnectEvent |
| 86 |
|
| 87 |
.. autoclass:: litestar.types.WebSocketAcceptEvent |
| 88 |
|
| 89 |
.. autoclass:: litestar.types.WebSocketReceiveEvent |
| 90 |
|
| 91 |
.. autoclass:: litestar.types.WebSocketSendEvent |
| 92 |
|
| 93 |
.. autoclass:: litestar.types.WebSocketResponseStartEvent |
| 94 |
|
| 95 |
.. autoclass:: litestar.types.WebSocketResponseBodyEvent |
| 96 |
|
| 97 |
.. autoclass:: litestar.types.WebSocketDisconnectEvent |
| 98 |
|
| 99 |
.. autoclass:: litestar.types.WebSocketCloseEvent |
| 100 |
|
| 101 |
.. autoclass:: litestar.types.LifeSpanStartupEvent |
| 102 |
|
| 103 |
.. autoclass:: litestar.types.LifeSpanShutdownEvent |
| 104 |
|
| 105 |
.. autoclass:: litestar.types.LifeSpanStartupCompleteEvent |
| 106 |
|
| 107 |
.. autoclass:: litestar.types.LifeSpanStartupFailedEvent |
| 108 |
|
| 109 |
.. autoclass:: litestar.types.LifeSpanShutdownCompleteEvent |
| 110 |
|
| 111 |
.. autoclass:: litestar.types.LifeSpanShutdownFailedEvent |
| 112 |
|
| 113 |
|
| 114 |
Event Groupings |
| 115 |
~~~~~~~~~~~~~~~ |
| 116 |
|
| 117 |
.. autodata:: litestar.types.HTTPReceiveMessage |
| 118 |
|
| 119 |
.. autodata:: litestar.types.WebSocketReceiveMessage |
| 120 |
|
| 121 |
.. autodata:: litestar.types.LifeSpanReceiveMessage |
| 122 |
|
| 123 |
.. autodata:: litestar.types.HTTPSendMessage |
| 124 |
|
| 125 |
.. autodata:: litestar.types.WebSocketSendMessage |
| 126 |
|
| 127 |
.. autodata:: litestar.types.LifeSpanSendMessage |
| 128 |
|
| 129 |
.. autodata:: litestar.types.LifeSpanReceive |
| 130 |
|
| 131 |
.. autodata:: litestar.types.LifeSpanSend |
| 132 |
|
| 133 |
Send / Receive Parameter Types |
| 134 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 135 |
|
| 136 |
.. autodata:: litestar.types.Message |
| 137 |
|
| 138 |
.. autodata:: litestar.types.ReceiveMessage |
| 139 |
|
| 140 |
|
| 141 |
Helper Types |
| 142 |
------------ |
| 143 |
|
| 144 |
Helper types are useful generic types that can be used. |
| 145 |
|
| 146 |
.. autoclass:: litestar.types.SyncOrAsyncUnion |
| 147 |
|
| 148 |
.. autoclass:: litestar.types.AnyIOBackend |
| 149 |
|
| 150 |
.. autoclass:: litestar.types.OptionalSequence |
| 151 |
|
| 152 |
|
| 153 |
Protocols |
| 154 |
--------- |
| 155 |
|
| 156 |
.. autoclass:: litestar.types.Logger |
| 157 |
|
| 158 |
|
| 159 |
Composite Types |
| 160 |
--------------- |
| 161 |
|
| 162 |
.. autoclass:: litestar.types.Dependencies |
| 163 |
|
| 164 |
.. autoclass:: litestar.types.ExceptionHandlersMap |
| 165 |
|
| 166 |
.. autodata:: litestar.types.Middleware |
| 167 |
|
| 168 |
.. autoclass:: litestar.types.ResponseCookies |
| 169 |
|
| 170 |
.. autoclass:: litestar.types.ResponseHeaders |
| 171 |
|
| 172 |
.. autoclass:: litestar.types.PathType |
| 173 |
|
| 174 |
.. autodata:: litestar.types.Scopes |
| 175 |
|
| 176 |
.. autoclass:: litestar.types.TypeEncodersMap |
| 177 |
|
| 178 |
.. autoclass:: litestar.types.TypeDecodersSequence |
| 179 |
|
| 180 |
.. autoclass:: litestar.types.ParametersMap |
| 181 |
|
| 182 |
|
| 183 |
File types |
| 184 |
---------- |
| 185 |
|
| 186 |
.. autoclass:: litestar.types.FileInfo |
| 187 |
:members: |
| 188 |
|
| 189 |
|
| 190 |
.. autoclass:: litestar.types.FileSystemProtocol |
| 191 |
:members: |