com.sass_lang.embedded_protocol

Class OutboundMessage.FileImportRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.sass_lang.embedded_protocol.OutboundMessage.FileImportRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutboundMessage.FileImportRequestOrBuilder, Serializable

Enclosing class:

OutboundMessage

public static final class OutboundMessage.FileImportRequest
extends com.google.protobuf.GeneratedMessage
implements OutboundMessage.FileImportRequestOrBuilder

 A request for a custom filesystem importer to load the contents of a
 stylesheet.

 A filesystem importer is represented in the compiler as an [importer]. When
 the importer is invoked with a string `string`:

 [importer]: https://github.com/sass/sass/tree/main/spec/modules.md#importer

 * If `string` is an absolute URL whose scheme is `file`:

 * Let `url` be string.

 * Otherwise:

 * Let `fromImport` be `true` if the importer is being run for an
 `@import` and `false` otherwise.

 * Let `containingUrl` be the canonical URL of the [current source file]
 if it has one, or undefined otherwise.


 * Let `response` be the result of sending a `FileImportRequest` with
 `string` as its `url`, `fromImport` as `from_import`, and
 `containingUrl` as `containing_url`.

 * If `response.result` is null, return null.

 * Otherwise, if `response.result.error` is set, throw an error.

 * Otherwise, let `url` be `response.result.file_url`.

 * Let `resolved` be the result of [resolving `url`].

 * If `resolved` is null, return null.

 * Let `text` be the contents of the file at `resolved`.

 * Let `syntax` be:
 * "scss" if `url` ends in `.scss`.
 * "indented" if `url` ends in `.sass`.
 * "css" if `url` ends in `.css`.

 > The algorithm for resolving a `file:` URL guarantees that `url` will have
 > one of these extensions.

 * Return `text`, `syntax`, and `resolved`.

 [current source file]: ../spec.md#current-source-file
 [resolving `url`]: https://github.com/sass/sass/tree/main/spec/modules.md#resolving-a-file-url
 

Protobuf type sass.embedded_protocol.OutboundMessage.FileImportRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutboundMessage.FileImportRequest.Builder A request for a custom filesystem importer to load the contents of a stylesheet.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINING_URL_FIELD_NUMBER
static int	FROM_IMPORT_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	IMPORTER_ID_FIELD_NUMBER
static int	URL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContainingUrl() The canonical URL of the [current source file] that contained the load being resolved.
com.google.protobuf.ByteString	getContainingUrlBytes() The canonical URL of the [current source file] that contained the load being resolved.
static OutboundMessage.FileImportRequest	getDefaultInstance()
OutboundMessage.FileImportRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFromImport() Whether this request comes from an `@import` rule.
int	getId() uint32 id = 1;
int	getImporterId() The unique ID of the importer being invoked.
com.google.protobuf.Parser<OutboundMessage.FileImportRequest>	getParserForType()
int	getSerializedSize()
String	getUrl() The (non-canonicalized) URL of the import.
com.google.protobuf.ByteString	getUrlBytes() The (non-canonicalized) URL of the import.
boolean	hasContainingUrl() The canonical URL of the [current source file] that contained the load being resolved.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OutboundMessage.FileImportRequest.Builder	newBuilder()
static OutboundMessage.FileImportRequest.Builder	newBuilder(OutboundMessage.FileImportRequest prototype)
OutboundMessage.FileImportRequest.Builder	newBuilderForType()
protected OutboundMessage.FileImportRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static OutboundMessage.FileImportRequest	parseDelimitedFrom(InputStream input)
static OutboundMessage.FileImportRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.FileImportRequest	parseFrom(byte[] data)
static OutboundMessage.FileImportRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.FileImportRequest	parseFrom(ByteBuffer data)
static OutboundMessage.FileImportRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.FileImportRequest	parseFrom(com.google.protobuf.ByteString data)
static OutboundMessage.FileImportRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.FileImportRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static OutboundMessage.FileImportRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.FileImportRequest	parseFrom(InputStream input)
static OutboundMessage.FileImportRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OutboundMessage.FileImportRequest>	parser()
OutboundMessage.FileImportRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

IMPORTER_ID_FIELD_NUMBER

public static final int IMPORTER_ID_FIELD_NUMBER

See Also:

Constant Field Values

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER

See Also:

Constant Field Values

FROM_IMPORT_FIELD_NUMBER

public static final int FROM_IMPORT_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINING_URL_FIELD_NUMBER

public static final int CONTAINING_URL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public int getId()

uint32 id = 1;

Specified by:

getId in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The id.

getImporterId

public int getImporterId()

 The unique ID of the importer being invoked. This must match an
 `Importer.file_importer_id` passed to this compilation in
 `CompileRequest.importers` or `CompileRequest.input.string.importer`.
 

uint32 importer_id = 3;

Specified by:

getImporterId in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The importerId.

getUrl

public String getUrl()

 The (non-canonicalized) URL of the import.
 

string url = 4;

Specified by:

getUrl in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The url.

getUrlBytes

public com.google.protobuf.ByteString getUrlBytes()

 The (non-canonicalized) URL of the import.
 

string url = 4;

Specified by:

getUrlBytes in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The bytes for url.

getFromImport

public boolean getFromImport()

 Whether this request comes from an `@import` rule.

 When evaluating `@import` rules, filesystem importers should load an
 [import-only file] if one exists for the URL being canonicalized.
 Otherwise, canonicalization should be identical for `@import` and `@use`
 rules.

 [import-only file]: https://sass-lang.com/documentation/at-rules/import#import-only-files
 

bool from_import = 5;

Specified by:

getFromImport in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The fromImport.

hasContainingUrl

public boolean hasContainingUrl()

 The canonical URL of the [current source file] that contained the load
 being resolved. The compiler must set this unless the current source file
 has no canonical URL.
 

optional string containing_url = 6;

Specified by:

hasContainingUrl in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

Whether the containingUrl field is set.

getContainingUrl

public String getContainingUrl()

 The canonical URL of the [current source file] that contained the load
 being resolved. The compiler must set this unless the current source file
 has no canonical URL.
 

optional string containing_url = 6;

Specified by:

getContainingUrl in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The containingUrl.

getContainingUrlBytes

public com.google.protobuf.ByteString getContainingUrlBytes()

 The canonical URL of the [current source file] that contained the load
 being resolved. The compiler must set this unless the current source file
 has no canonical URL.
 

optional string containing_url = 6;

Specified by:

getContainingUrlBytes in interface OutboundMessage.FileImportRequestOrBuilder

Returns:

The bytes for containingUrl.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutboundMessage.FileImportRequest parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutboundMessage.FileImportRequest parseDelimitedFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.FileImportRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

newBuilderForType

public OutboundMessage.FileImportRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OutboundMessage.FileImportRequest.Builder newBuilder()

newBuilder

public static OutboundMessage.FileImportRequest.Builder newBuilder(OutboundMessage.FileImportRequest prototype)

toBuilder

public OutboundMessage.FileImportRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OutboundMessage.FileImportRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static OutboundMessage.FileImportRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<OutboundMessage.FileImportRequest> parser()

getParserForType

public com.google.protobuf.Parser<OutboundMessage.FileImportRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public OutboundMessage.FileImportRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder