ArxivResponse

public struct ArxivResponse : Codable
extension ArxivResponse: CustomStringConvertible

A parsed arXiv API reponse.

  • id

    Returns the value of arXiv feed id element.

    From arxiv API manual:

    The <id> element serves as a unique id for query defined by reponse’s title, and is useful if you are writing a program such as a feed reader that wants to keep track of all the feeds requested in the past. This id can then be used as a key in a database.

    The id is guaranteed to be unique for each query.

    Declaration

    Swift

    public internal(set) var id: String { get }

  • Returns the value of arXiv feed title element.

    From arxiv API manual:

    The title contains a canonicalized version of the query used to call the API. The canonicalization includes all parameters, using their defaults if they were not included, and always puts them in the order search_query, id_list, start, max_results, even if they were specified in a different order in the actual query.

    Declaration

    Swift

    public internal(set) var title: String { get }

  • Returns the value of arXiv feed link element.

    From arxiv API manual:

    The <link> element provides a URL that can be used to retrieve this feed again.

    Note that the url in the link represents the canonicalized version of the query. The <link> provides a GET requestable url, even if the original request was done via POST.

    Declaration

    Swift

    public internal(set) var link: URL { get }

  • Returns the value of arXiv feed updated element.

    From arxiv API manual:

    The updated element provides the last time the contents of the feed were last updated:

    Because the arXiv submission process works on a 24 hour submission cycle, new articles are only available to the API on the midnight after the articles were processed. The updated tag thus reflects the midnight of the day that you are calling the API. This is very important - search results do not change until new articles are added. Therefore there is no need to call the API more than once in a day for the same query. Please cache your results. This primarily applies to production systems, and of course you are free to play around with the API while you are developing your program!

    Declaration

    Swift

    public internal(set) var updatedDate: Date { get }

  • Returns total number of articles matching the query as specified by ArxiveRequest.

    Declaration

    Swift

    public internal(set) var totalResults: Int { get }

  • Returns zero-based index of the first article in response as specified by ArxiveRequest,

    Declaration

    Swift

    public internal(set) var startIndex: Int { get }

  • Returns maximum number of article per response as specified by ArxiveRequest,

    Declaration

    Swift

    public internal(set) var itemsPerPage: Int { get }

  • Returns an array od articles matching the query specified by ArxiveRequest.

    Declaration

    Swift

    public internal(set) var entries: [ArxivEntry] { get }

  • Returns total number od pages of the reponse.

    Declaration

    Swift

    var numberOfPages: Int { get }

  • Returns zero-based index for current page.

    Note

    This is the index of the current page itself, not start index of the first article in the reposnse. The latter is obtained from startIndex property.

    Declaration

    Swift

    var currentPage: Int { get }

  • Returns zero-based startIndex of the previous page, or nil if currentPage == 0.

    Declaration

    Swift

    var previousPageStartIndex: Int? { get }

  • Returns zero-based startIndex of the next page, or nil if currentPage == numberOfPages - 1.

    Declaration

    Swift

    var nextPageStartIndex: Int? { get }

  • Returns zero-based startIndex of the last page.

    Declaration

    Swift

    var lastPageStartIndex: Int { get }

  • Declaration

    Swift

    public var description: String { get }