page.go (package eai)
Source : sdks/go/page.go. Retour à l'index de la référence du SDK Go.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe Page
Page est une page d'une collection paginée par curseur {"items": [...], "next_cursor": "..."|null}.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Items | []json.RawMessage | oui | Éléments de cette page en JSON brut ; à décoder avec Decode ou json.Unmarshal. |
NextCursor | string | oui | Curseur de la page suivante (next_cursor), vide sur la dernière page. |
Page.HasNext
HasNext() bool
HasNext indique s'il existe une autre page.
Cet élément ne prend aucun paramètre.
Retour : bool. true quand NextCursor n'est pas vide.
Page.Iter
Iter() *Iterator
Iter renvoie un itérateur sur tous les éléments de cette page et des suivantes.
Cet élément ne prend aucun paramètre.
Retour : *Iterator. Un *Iterator placé avant le premier élément de cette page.
Page.Next
Next(ctx context.Context) (*Page, error)
Next charge la page suivante.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. |
Retour : (*Page, error). Une Page : une page d'une collection paginée par curseur {"items": [...], "next_cursor": "..."|null}. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.
Classe Iterator
Iterator parcourt tous les éléments à travers les pages, en les chargeant à la demande.
Iterator.All
All(ctx context.Context) ([]json.RawMessage, error)
All rassemble tous les éléments restants.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. |
Retour : ([]json.RawMessage, error). Tous les éléments restants en JSON brut, et l'erreur qui a arrêté le parcours, nil quand toutes les pages ont été lues.
Erreurs levées : error.
Iterator.Err
Err() error
Err renvoie l'erreur qui a arrêté l'itération, s'il y en a une.
Cet élément ne prend aucun paramètre.
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Iterator.Item
Item() json.RawMessage
Item renvoie l'élément courant.
Cet élément ne prend aucun paramètre.
Retour : json.RawMessage. JSON brut de l'élément courant ; à appeler seulement après un Next qui a renvoyé true.
Iterator.Next
Next(ctx context.Context) bool
Next avance ; renvoie false à la fin ou sur une erreur (voir Err).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. |
Retour : bool. true quand un élément est disponible, en chargeant la page suivante quand la page courante est épuisée.