Classes Reference


                    
                    
                    CorvusToken

A default implementation of a bearer token.

Declaration

Swift

public final class CorvusToken : CorvusModel

extension CorvusToken: CorvusModelTokenAuthenticatable


                    
                    
                    CorvusUser

A default implementation of a user for basic authentication.

Declaration

Swift

public final class CorvusUser : CorvusModel

extension CorvusUser: CorvusModelAuthenticatable


                    
                    
                    Create

A class that provides functionality to create objects of a generic type T conforming to CorvusModel.

Declaration

Swift

public final class Create<T> : CreateEndpoint where T : CorvusModel


                    
                    
                    Custom

A class that contains custom functionality passed in by the implementor for a generic type T conforming to CorvusModel grouped under a given path.

Declaration

Swift

public final class Custom<T, R> : RestEndpoint where T : CorvusModel, R : ResponseEncodable


                    
                    
                    Delete

A class that provides functionality to delete objects completely of a generic type T conforming to CorvusModel and identified by a route parameter.

Declaration

Swift

public final class Delete<T> : AuthEndpoint where T : CorvusModel


                    
                    
                    Login

A class that provides functionality to log in a user with username and password credentials sent in a HTTP POST Request and save a token for that user. Needs an object of type T which represents the token to be created upon login.

Declaration

Swift

public final class Login<
    T: CorvusModelTokenAuthenticatable & ResponseEncodable>:
Endpoint where T.User: CorvusModelAuthenticatable


                    
                    
                    AuthModifier

A class that wraps a component which utilizes an .auth() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to AuthEndpoint. Requires an object U that represents the user to authorize.

Declaration

Swift

public class AuthModifier<
    A: AuthEndpoint,
    U: CorvusModelAuthenticatable>:
RestModifier<A>, AuthEndpoint


                    
                    
                    CreateAuthModifier

A class that wraps a Create component which utilizes an .auth() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to CreateAuthModifier. Requires an object U that represents the user to authorize.

Declaration

Swift

public final class CreateAuthModifier<
    A: CreateEndpoint,
    U: CorvusModelAuthenticatable>:
AuthModifier<A, U>, CreateEndpoint


                    
                    
                    NestedAuthModifier

A class that wraps a component which utilizes an .auth() modifier. Differs from AuthModifier by authenticating on the user of an intermediate parent I of A.QuerySubject. Requires an object U that represents the user to authorize.

Declaration

Swift

public class NestedAuthModifier<
    A: AuthEndpoint,
    I: CorvusModel,
    U: CorvusModelAuthenticatable>:
RestModifier<A>, AuthEndpoint


                    
                    
                    NestedCreateAuthModifier

A class that wraps a Create component which utilizes an .auth() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to NestedCreateAuthModifier. Requires an object U that represents the user to authorize.

Declaration

Swift

public final class NestedCreateAuthModifier<
    A: CreateEndpoint,
    I: CorvusModel,
    U: CorvusModelAuthenticatable>:
NestedAuthModifier<A, I, U>, CreateEndpoint


                    
                    
                    NestedReadAllAuthModifier

A class that wraps a component which utilizes an .auth() modifier. Differs from AuthModifier by authenticating on the user of an intermediate parent I of A.QuerySubject. Requires an object U that represents the user to authorize.

Declaration

Swift

public final class NestedReadAllAuthModifier<
    A: AuthEndpoint,
    I: CorvusModel,
    U: CorvusModelAuthenticatable>:
ReadEndpoint


                    
                    
                    ReadAll

A class that provides functionality to read all objects of a generic type T conforming to CorvusModel.

Declaration

Swift

public final class ReadAll<T> : ReadEndpoint where T : CorvusModel


                    
                    
                    ReadAllAuthModifier

A class that wraps a component which utilizes an .auth() modifier. Differs from AuthModifier by authenticating on the user of an intermediate parent I of A.QuerySubject. Requires an object U that represents the user to authorize.

Declaration

Swift

public final class ReadAllAuthModifier<
    A: AuthEndpoint,
    U: CorvusModelAuthenticatable>:
ReadEndpoint


                    
                    
                    UpdateAuthModifier

A class that wraps a Update component which utilizes an .auth() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to UpdateAuthModifier. Requires an object U that represents the user to authorize.

Declaration

Swift

public final class UpdateAuthModifier<
    A: UpdateEndpoint,
    U: CorvusModelAuthenticatable>:
AuthModifier<A, U>, UpdateEndpoint


                    
                    
                    UserAuthModifier

A class that wraps a component which utilizes an .userAuth() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to AuthEndpoint.

Declaration

Swift

public final class UserAuthModifier<
    A: AuthEndpoint
>: RestModifier<A>, AuthEndpoint
where A.QuerySubject: CorvusModelAuthenticatable


                    
                    
                    ResponseModifier

A class that wraps a component which utilizes a .respond(with:) modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to RestEndpoint.

Declaration

Swift

public final class ResponseModifier<E: RestEndpoint, R: CorvusResponse>:
RestEndpoint where E.Element == R.Item


                    
                    
                    ChildrenModifier

A class that wraps a component which utilizes a .children() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to ReadEndpoint.

Declaration

Swift

public final class ChildrenModifier<
    R: ReadEndpoint,
    M: CorvusModel>:
ReadEndpoint


                    
                    
                    FilterModifier

A class that wraps a component which utilizes a .filter() modifier. That allows Corvus to chain modifiers, as it gets treated as any other struct conforming to ReadEndpoint.

Declaration

Swift

public final class FilterModifier<
    R: ReadEndpoint
>: ReadEndpoint


                    
                    
                    ReadOne

A class that provides functionality to read objects of a generic type T conforming to CorvusModel and identified by a route parameter.

Declaration

Swift

public final class ReadOne<T> : ReadEndpoint where T : CorvusModel


                    
                    
                    Restore

A class that provides functionality to restore soft-deleted objects of a generic type T conforming to CorvusModel and identified by a route parameter.

Declaration

Swift

public final class Restore<T> : AuthEndpoint where T : CorvusModel


                    
                    
                    Update

A class that provides functionality to update objects of a generic type T conforming to CorvusModel and identified by a route parameter.

Declaration

Swift

public final class Update<T> : UpdateEndpoint where T : CorvusModel


                    
                    
                    User

A class that contains Create, Read, Update and Delete functionality for a generic type T representing a user object.

Declaration

Swift

public final class User<T> : Endpoint where T : CorvusModelAuthenticatable


                    
                    
                    RestModifier

A class that wraps a RestEndpoint with additional functionalty. This allows Corvus to chain modifiers, as it gets treated as any other struct conforming to RestEndpoint.

Declaration

Swift

public class RestModifier<R> : RestEndpoint where R : RestEndpoint

Api

A convenience wrapper around RestApi.

Wraps RestApi by using a Group component to reduce indendation when creating a Api.

Declaration

Swift

public final class Api : RestApi