package reddit_api_kernel

  1. Overview
  2. Docs
package reddit_api_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

Subreddit_name is a string identifier module that does some normalization:

  • Hashes and comparisons are caseless.
  • "r/" and "/r/" prefixes are dropped.
  • "u/" and "/u/" prefixes cause the string to be converted to the user's subreddit.
type t
val all : t

all is /r/all, a special subreddit that includes items from most subreddits.

Exceptions:

  1. Some subreddits are excluded by Reddit administrators.
  2. Some subreddits opt out of inclusion.
  3. Users can filter individual subreddits out of their view of /r/all.
val combine : t list -> t

combine l is a subreddit name representing the combination of the subreddits named in l. In general, when combine l is used as an API parameter the response contains items from all the subreddits in l.

val user_subreddit : Username.t -> t

user_subreddit user is the name of the special subreddit associated with the user's profile. Only the user can post to this subreddit, and on the desktop site links in this subreddit are associated with the user rather than with any visible subreddit.

include Core_kernel.Identifiable.S with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val of_string : string -> t
val to_string : t -> string
val pp : Base__.Formatter.t -> t -> unit
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val validate_lbound : min:t Core__.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core__.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core__.Maybe_bound.t -> max:t Core__.Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : sig ... end
val comparator : (t, comparator_witness) Core__Comparator.comparator
module Map : sig ... end
module Set : sig ... end
val hash_fold_t : t Base__Ppx_hash_lib.hash_fold
val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core__.Hashtbl.Hashable.t
module Table : sig ... end
module Hash_set : sig ... end
module Hash_queue : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct